docs: add cli documentation

[kmendell]

Disclaimer Greptiles Review uses AI, make sure to check over its work

Greptile Overview

Updated On: 2025-10-22 00:42:21 UTC

Greptile Summary

This PR adds comprehensive CLI documentation to the Arcane documentation site. It introduces a new cli content collection processed by Velite, creates individual markdown pages for each CLI command (arcane, generate, generate-secret, help, version), and implements a reusable CliCommand Svelte component for consistent rendering. The documentation is integrated into the site's routing and navigation by modifying velite.config.js, docs.ts, and adding the CLI section to the sidebar between Features and Guides. Additionally, existing setup documentation (installation.md, socket-proxy.md) was updated to reference the new CLI-based secret generation method alongside the previous openssl approach. The implementation follows the established pattern in the codebase where centralized configuration (cli-commands.ts) feeds reusable components, maintaining a single source of truth for command metadata while enabling DRY documentation.

PR Description Notes:

• The PR description is empty. Consider adding a summary of changes, motivation, and any breaking changes or migration steps for reviewers and future reference.

Important Files Changed

Changed Files

Filename	Score	Overview
content/cli/generate.md	4/5	New CLI documentation page for arcane generate command; contains typo "Arcanes" (should be "Arcane's") in description.
content/cli/help.md	5/5	New CLI documentation page for arcane help command; clean implementation following established pattern.
src/routes/docs/[...slug]/+page.ts	5/5	Integrates CLI collection into doc routing by importing and spreading cli into ALL_DOCS array.
content/setup/socket-proxy.md	4/5	Adds new section documenting CLI-based secret generation; contains typo "previoulsy" (should be "previously").
velite.config.js	5/5	Registers new cli collection to process CLI markdown files; removes trailing commas for consistency.
content/cli/generate-secret.md	5/5	New CLI documentation page for arcane generate secret command; clean implementation.
src/lib/docs.ts	4/5	Adds CLI collection to doc loader; missing trailing semicolon on ...cli line (inconsistent with other array elements).
content/cli/version.md	5/5	New CLI documentation page for arcane version command; follows established pattern correctly.
content/cli/arcane.md	4/5	Root CLI documentation page; contains typo "Arcanes" and unused ARCANE_COMMANDS import.
src/lib/config/docs.ts	5/5	Adds CLI section to navigation sidebar; removes unused indexPage import; clean implementation.
content/setup/installation.md	3/5	Adds CLI secret generation documentation but creates duplicate section 4 headings; contains typo "previoulsy".
src/lib/components/cli-command.svelte	5/5	New reusable component for rendering CLI documentation; uses Svelte 5 runes correctly.
src/lib/config/cli-commands.ts	4/5	Central CLI configuration with TypeScript interfaces; globalFlags field unused; 'generate' includes itself in aliases array.

Confidence score: 3/5

• This PR contains useful documentation additions but has several quality issues that should be addressed before merging, including typos, duplicate headings, and unused code.
• Score reflects clear typos in multiple files ("Arcanes" should be "Arcane's", "previoulsy" should be "previously"), duplicate section numbering in installation.md (two "## 4" headings), an unused import in arcane.md, and a potentially problematic self-reference in the 'generate' command aliases array that could cause conflicts.
• Pay close attention to content/setup/installation.md (duplicate section 4 headings breaking document structure), content/cli/arcane.md (unused import), content/cli/generate.md (typo in description), and src/lib/config/cli-commands.ts (unused globalFlags field and self-referential alias).

Context used:

• Context from dashboard - .github/copilot-instructions.md file (source)

[greptile-apps]

_{13 files reviewed, 13 comments}

_{Edit Code Review Agent Settings | Greptile}

[github-actions]

🚀 Preview deployed successfully!

Preview URL: https://pr-102-arcane.ofkm.workers.dev

Built from commit 1feba42

---

_{Powered by Cloudflare Workers}