Add Reference section for CLI commands - #76
Conversation
3cf76c9 to
4b389ae
Compare
4b389ae to
4b0c5be
Compare
arrufat
left a comment
There was a problem hiding this comment.
Checked everything against browser main (f55aa1a66) and this one is fully up to date: every option block matches help.zon verbatim, including the newest flags (--block-urls, the mcp HTTP options, --save, the updated http defaults), and the REPL tables match SlashCommand.zig exactly, /stream and /searchEngine included. All new anchors resolve and no stale links to the deleted pages remain. Three small notes inline.
| '/cloud-offer/tools/mcp': '/usage/mcp', | ||
| '/cloud-offer/tools/api': '/usage/api', | ||
| '/run-locally/commands/fetch': '/run-locally/commands#fetch', | ||
| '/run-locally/commands/serve': '/run-locally/commands#serve', |
There was a problem hiding this comment.
Take it or leave it: these are the first fragment redirects, and the stub JS in generate-redirects.mjs does location.replace(href + location.hash), so an old bookmarked anchor like /run-locally/commands/serve#options lands on …/commands#serve#options. Probably fine to ignore, just flagging since the generator predates fragment targets.
There was a problem hiding this comment.
It requires just 1 line change in generate-redirect.js. Are you ok with this fix?
b455282:
docs/scripts/generate-redirects.mjs
Line 26 in b455282
|
Heads up: #72 edits the four files this PR deletes/consolidates. It'll need to be closed once this merges. |
…own options block
…arget already has one
Summary
reference/cli/section documenting each command's full option spec (agent,fetch,mcp,serve,run,version) plus sharedcommon-options, sourced from the last version ofhelp.zonrun-locally/commands/*usage guides into a singlerun-locally/commands.mdxpageusage/agent.mdxdown to a practical guide, linking to the new reference for exhaustive option/REPL-command detail## helpsection toreference/cli/index.mdx(previously undocumented) and the missing/saveREPL command row toreference/cli/agent.mdx--cookie/--cookie-jarfromreference/cli/mcp.mdx's own options block:help.zonduplicates them there (unlike.agent/.run), but they're identical tocommon-options.mdx, so the same dedup policy asfetch/serveappliesThe option specs are copied verbatim from
help.zon(the CLI's authoritative--helptext). One deliberate exception: the real--helpoutput for each command prints its own options followed by the common options in one combined block, but our docs split them — each command page shows only its own options, and the shared ones live once oncommon-options.mdxinstead of being repeated on every command page.This PR is part of a series splitting the new Reference section (CLI, MCP tools, HTTP API, PandaScript) into smaller pieces so each can be reviewed and merged on its own: #77 (MCP tools reference), #78 (PandaScript reference).
reference/cli/mcp.mdxandrun-locally/commands.mdxlink to/usage/mcp#toolsinstead of/reference/mcp-tools;run-locally/commands.mdxalso links to/usage/mcp#connecting-an-ai-agent, which Add Reference section for MCP tools #77 renames to#connect-an-ai-agent. Update all three once Add Reference section for MCP tools #77 merges.reference/cli/index.mdxand the new/saverow inreference/cli/agent.mdxlink to/usage/pandascriptinstead of/reference/pandascript. Update once Add Reference section for PandaScript #78 merges.