diff --git a/plugins/visual-explainer/commands/share.md b/plugins/visual-explainer/commands/share.md index 27533c5..4c8e586 100644 --- a/plugins/visual-explainer/commands/share.md +++ b/plugins/visual-explainer/commands/share.md @@ -1,58 +1,13 @@ -# Share Visual Explainer Page +--- +name: share +description: Share a visual explainer HTML page via Vercel and return a live URL +--- +Share the HTML file at `$1` using the visual-explainer share script. -Share a visual explainer HTML file instantly via Vercel. Returns a live URL with no authentication required. +Run: `bash {{skill_dir}}/scripts/share.sh $1` -## Usage +The script copies the file to a temp directory as `index.html`, deploys it via the vercel-deploy skill, and prints the live URL. No Vercel account or API keys are needed — the deployment is publicly accessible and claimable. -``` -/share -``` +If no file path is provided, list HTML files in `~/.agent/diagrams/` and ask the user to select one. -**Arguments:** -- `file-path` - Path to the HTML file to share (required) - -**Examples:** -``` -/share ~/.agent/diagrams/my-diagram.html -/share /tmp/visual-explainer-output.html -``` - -## How It Works - -1. Copies your HTML file to a temp directory as `index.html` -2. Deploys via the vercel-deploy skill (no auth needed) -3. Returns a live URL immediately - -## Requirements - -- **vercel-deploy skill** - Should be pre-installed. If not: `pi install npm:vercel-deploy` - -No Vercel account, Cloudflare account, or API keys needed. The deployment is "claimable" — you can transfer it to your Vercel account later if you want. - -## Script Location - -```bash -bash {{skill_dir}}/scripts/share.sh -``` - -## Output - -``` -Sharing my-diagram.html... - -✓ Shared successfully! - -Live URL: https://skill-deploy-abc123.vercel.app -Claim URL: https://vercel.com/claim-deployment?code=... -``` - -The script also outputs JSON for programmatic use: -```json -{"previewUrl":"https://...","claimUrl":"https://...","deploymentId":"...","projectId":"..."} -``` - -## Notes - -- Deployments are **public** — anyone with the URL can view -- Preview deployments have a configurable retention period (default: 30 days) -- Each share creates a new deployment with a unique URL +Report the live URL and claim URL to the user when the deployment succeeds.