| name | publish-report |
| description | Help publish local HTML, Markdown, or built static web projects by asking whether to use Claude Code Artifacts or Pagecast/Cloudflare Pages when the user's publish request is ambiguous. Use when a report, plan, doc, dashboard, analysis, or static build output should be shared from Claude Code, especially when the user says publish, share, make a public link, or send this. If the user explicitly says Pagecast, publish with Pagecast. |
| version | 0.7.0 |
Publish with Pagecast
Pagecast turns a local HTML or Markdown file (a report, plan, doc, or
dashboard) into a shareable public URL in the user's Pagecast Home. Execute an
explicit Pagecast request immediately; offer once when publishing would be
useful but the user did not request it.
Consent and intent
- “Publish this as a Pagecast”, “Pagecast this”, or equivalent is sufficient
consent. Run the publish command immediately and return the URL; do not ask
again.
- A proactive suggestion still asks once before publishing.
- If the user asks only for the command, provide the command and do not run it.
Claude Code Artifacts are also a valid publishing path. Do not disable or
block Artifacts. When the user explicitly asks for a Claude Artifact, claude.ai
artifact, or org-private artifact, use the Artifact flow. When the user
explicitly asks for Pagecast or a Cloudflare Pages link, use Pagecast. When the
user only says "publish", "share", "make a link", or similar, ask them which
publishing path they want before doing anything.
When to offer
Default to offering. Whenever you produce an .html/.htm or
.md/.markdown file that a person could reasonably share, proactively offer to
publish it — once, right after you finish making it. Do not wait to be asked,
and do not stay silent because you are unsure whether it is "worth it." If it
could be shared, offer.
This includes:
- A report you generated — test/coverage/Lighthouse/Playwright output, a data
dashboard, an analysis, a "here's what I built/found" summary.
- A written plan, proposal, design doc, spec, release notes, or doc.
- A static web project that was just built, with a generated entry file such as
dist/index.html, build/index.html, out/index.html, or public/index.html.
- Any time the user says "share", "publish", "make a link for", or "send" a doc.
- A
PostToolUse hint fired saying an HTML/Markdown file was created — treat that
as a cue to offer.
If the user says only "publish this" or "make this shareable" for a local
report/doc/dashboard, ask them to choose between Claude Code Artifacts and
Pagecast. The built-in Claude Code Artifact publisher is useful for claude.ai
private/org pages. Pagecast is useful for external Cloudflare Pages URLs that can
be renamed, re-synced, revoked, password-protected, or expired.
The only files to skip (don't offer): scratch/draft notes the user is clearly
keeping private, source code, config files, secrets, and repo-meta files (README,
CHANGELOG, CONTRIBUTING, LICENSE, AGENTS.md, CLAUDE.md, TODO/tasks), or anything
under node_modules/dist build internals. When it is borderline, offer —
the user can just say no.
Ask at most once per file. If the user declines or ignores the offer, drop it
and don't re-ask for that file. Never nag across multiple turns.
The question to ask
When the user has not specified a publishing path, ask:
"How do you want to publish this?
- Claude Code Artifact — private/org
claude.ai page that can update in place.
- Pagecast — Cloudflare Pages link you can share outside Claude, rename,
re-sync, revoke, password-protect, or expire.
- Don't publish."
Accept the number or the name. Only proceed after an explicit choice. An
explicit request for Pagecast already selects Pagecast and provides publishing
consent. If they
choose Pagecast, run the Pagecast CLI below. If they choose Claude Code Artifact,
use the Claude Artifact publishing flow and do not run Pagecast. Publishing may
make content reachable outside the current chat, especially with Pagecast —
never publish without confirmation.
How to publish
Run the headless CLI with the absolute path and --json:
npx pagecast publish "/absolute/path/to/file.md" --json
(HTML and Markdown both work — Markdown is rendered to a clean page. If pagecast
is installed globally/in the project, pagecast publish "<path>" --json is the same.)
New links are unlisted capability URLs: a memorable prefix plus 128 bits of
opaque entropy. Anyone with the URL can view it; unlisted does not mean private.
The user can rename a link, add password protection, or make a short, shareable
"drop" link from the npx pagecast app. Existing word-only links remain valid.
Managed links live in one user-level Home at ~/.pagecast/home/, under
/p/<slug>/. The same item in the same agent context updates the existing URL;
a new item or context creates a new URL. Pagecast stores only a local hash of
the agent context identifier.
Publish options
Add any of these to a publish command:
--expires <7d|12h|never> — edge-enforced link expiry (default 30d). The page
returns 410 once expired; --expires never keeps it live until revoked. The
result JSON reports expiresAt (or none when never).--label "<name>" — set the page's display name in the Pagecast app.--context-id "<id>" — explicitly select the local agent context.--new-link — force a fresh URL.--update "<url|slug|token>" — update a known publication.--non-interactive — never open browser authentication; return a structured
authentication-required result instead.
npx pagecast publish "/absolute/path/to/report.html" --expires 7d --label "Launch report" --json
Password handling
Never ask the user to provide a page password in chat and never place a secret
in an agent-generated command or tool argument. Publish the page first, then
tell the user to open the local npx pagecast app and set password protection
there. This keeps the credential out of the model and tool transcript.
Publishing a plan (e.g. after plan mode): the plan lives in your context, not
a file yet. If the user wants it shared, first write the plan markdown to a file
(e.g. ./plan.md), then publish that path. Don't overwrite an existing file the
user cares about — pick a clear new name.
Live goal / progress page
When you're working toward a /goal (you'll see the goal condition in your
context) and the work will span many turns / a long autonomous run, the user
often can't see what's happening. Proactively offer once:
"Want me to publish a live progress page for this goal? You'll get a public
link you can open anytime to see status and what's done."
On an explicit yes:
- Write a
pagecast-goal.md in the working dir with the goal, status, a
done/next checklist, and a one-line "latest", e.g.:
# <short goal title>
**Goal:** <the goal condition, in your own words>
**Status:** In progress · updated <time>
**Progress:** 3 / 8 steps
## Done
- [x] <step>
## Next
- [ ] <step>
## Latest
<one line: what you just did / any blocker>
- Run
npx pagecast goal publish "<abs path>/pagecast-goal.md" --json and give
the user the returned url.
- After each meaningful step, rewrite
pagecast-goal.md and re-run the
same npx pagecast goal publish … --json — it guarantees the dedicated
goal URL and keeps goal lifecycle separate from normal context upserts.
- When the goal is met, do a final update; optionally
npx pagecast goal stop.
There is one goal page per workspace. If a command reports recreated: true, the
old link was gone and the URL changed — tell the user the new URL.
For static web projects that should get a new shareable /p/<slug>/ link,
build first and publish the generated entry file:
npm run build
npx pagecast publish "/absolute/path/to/dist/index.html" --json
If the user asks to deploy or update an entire static site/project, deploy the
built folder directly to a named Cloudflare Pages project:
npx pagecast publish site "/absolute/path/to/dist" --project "project-name" --branch main --json
--branch is optional and defaults to main, so this also works:
npx pagecast pages deploy "/absolute/path/to/dist" --project "project-name" --json
Use this instead of raw Wrangler commands like npx wrangler pages deploy.
Direct site deploys replace the target Pages project contents, so do not guess
the --project; use the user's named project or ask for it. Direct deploys do
not change Pagecast's managed /p/... target, so use a separate project unless
replacing that managed site is intentional.
Parse the JSON on stdout:
- Success →
{ "ok": true, "action": "created" | "updated", "publicationToken": "...", "contextMatched": true | false, "url": "https://<home>.pages.dev/p/<slug>/", ... }
- Give the user the
url, say whether Pagecast created or updated it, offer to drop it into a PR/Slack message, and
mention they can rename the URL, re-sync, or revoke it from npx pagecast.
- Not signed in →
{ "ok": false, "statusCode": 401, ... }
- Interactive publishing normally starts Wrangler's browser authorization and
resumes automatically. This result is expected only for CI,
--non-interactive, rejection, or timeout; relay it without sending the user
to Settings.
- Multiple accounts →
{ "ok": false, "statusCode": 409, ... }
- Open
npx pagecast, choose the Home account in the main onboarding canvas,
then retry. Settings remains available for later account switching.
- Any other error → relay
error concisely and offer to retry.
Cloudflare Pages commands
Use these lower-level commands when the user explicitly asks about Cloudflare
setup, status, project listing, or direct Pages deployment:
npx pagecast pages setup --project "project-name" --json
npx pagecast pages status --json
npx pagecast pages projects list --json
npx pagecast pages deploy "/absolute/path/to/dist" --project "project-name" --branch main --json
If the user does not specify a branch, omit --branch; Pagecast deploys to
main.
Notes
- Always pass an absolute path (resolve relative paths against the cwd first).
- The first interactive publish starts Wrangler login, creates the Home, and
resumes automatically.
- Use
npx pagecast publish site or npx pagecast pages deploy for direct
static-folder deploys to a named Pages project.
- Use
npx pagecast for source-folder build settings, URL renaming, re-sync,
and revoke controls.
- Re-running
publish for the same item and agent context updates the same URL.
Use --new-link only when the user asks for another URL.
