Add CLI documentation tab#7
Merged
jonathanpopham merged 2 commits intomainfrom Apr 29, 2026
Merged
Conversation
New "CLI" tab covering the Supermodel command-line tool, sourced from the v0.6.0 source tree (cmd/*.go) and authoritative --help output. Pages: cli/overview — what the CLI does, the .graph.* sidecar pattern cli/install — brew, curl, npm, source, setup wizard, self-update cli/quickstart — login → analyze --three-file → skill → watch cli/file-mode — watch daemon, three-file shards, hook, clean cli/agents — Claude Code, Cursor, Copilot, Windsurf, Aider, MCP cli/configuration — config file, env vars, CI defaults cli/commands — full reference for every command, flag, and alias Also surfaces the CLI from the docs landing page (CardGroup with API + CLI) so it's discoverable from /.
WalkthroughThis pull request adds comprehensive CLI documentation to the Supermodel docs site, including installation and quickstart guides, a new CLI navigation section, and reference pages for 22 individual CLI commands covering authentication, analysis, graph visualization, code cleanup, and integration tooling. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 3/5 reviews remaining, refill in 21 minutes and 33 seconds. Comment |
2 tasks
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
cli/install.mdx (1)
18-19: Consider adding an integrity-verification step for the curl installer.
curl ... | shis convenient, but adding a checksum/signature verification option in docs would improve supply-chain safety for cautious users and CI environments.Also applies to: 74-75
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@cli/install.mdx` around lines 18 - 19, Replace the direct pipe-to-shell example "curl -fsSL https://supermodeltools.com/install.sh | sh" with a documented two-step alternative: first download the script to a file (e.g., save as install.sh) and fetch a published checksum/signature alongside it, then verify the file using shasum/sha256sum and/or gpg before executing; update the examples around the existing curl string so you show (1) curl -o install.sh <url>, (2) curl -o install.sh.sha256 or curl <url>.asc, (3) verify with sha256sum --check or gpg --verify, and only then run sh install.sh, and mention the optional CI-friendly non-interactive flags. Ensure the docs include the exact curl command string being replaced and a short note pointing to where users can find the canonical checksum/signature.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@cli/commands.mdx`:
- Around line 52-55: The docs for the `clean` command currently say “Remove all
`.graph.*` files” which conflicts with the promoted three-file shard set; update
the `clean` command description so it explicitly lists the full set of shard
filenames it removes (e.g., `.graph.*`, `.calls.*`, `.deps.*`, and `.impact.*`)
or state that it removes any shard files matching the pattern
`.{graph,calls,deps,impact}.*`; change the line under the `clean` heading to
unambiguously reflect this behavior so users know exactly which files `clean`
deletes.
In `@cli/configuration.mdx`:
- Around line 16-25: Update the wording that currently mentions only ".graph.*"
(the "files: true" description and any sentences that call out ".graph.*") to
use the broader term "graph sidecars" and explicitly note that this includes all
shard formats such as ".graph.*", ".calls.*", ".deps.*", and ".impact.*"; ensure
the phrase replaces any narrow mentions so the Environment variables /
SUPERMODEL_FILES description consistently refers to "graph sidecars" (including
those specific shard file patterns).
In `@cli/install.mdx`:
- Line 3: Update the cli/install.mdx docs to include an explicit Windows-native
install example alongside the macOS/Linux lines: add a PowerShell npm install
snippet (e.g., "npm install -g `@supermodel/cli`" run in an elevated PowerShell)
and optionally a native package manager variant (winget or choco) with the exact
command to install the Supermodel CLI; place these examples where the existing
platform install commands appear so Windows is unambiguous and mirrors the
macOS/Linux examples already present.
In `@cli/overview.mdx`:
- Line 7: The sentence in overview.mdx claiming “no prompt changes” conflicts
with guidance in cli/quickstart.mdx and cli/file-mode.mdx that recommend
appending "supermodel skill" to agent instructions; update the phrasing in
overview.mdx (the line containing “no prompt changes, no extra context windows,
no agent-specific integration”) to a softened version such as “works without
deep agent-specific integrations, with optional prompt guidance” so it
accurately reflects that the CLI can be used out-of-the-box but may benefit from
optional prompt/appended instructions like `supermodel skill`.
---
Nitpick comments:
In `@cli/install.mdx`:
- Around line 18-19: Replace the direct pipe-to-shell example "curl -fsSL
https://supermodeltools.com/install.sh | sh" with a documented two-step
alternative: first download the script to a file (e.g., save as install.sh) and
fetch a published checksum/signature alongside it, then verify the file using
shasum/sha256sum and/or gpg before executing; update the examples around the
existing curl string so you show (1) curl -o install.sh <url>, (2) curl -o
install.sh.sha256 or curl <url>.asc, (3) verify with sha256sum --check or gpg
--verify, and only then run sh install.sh, and mention the optional CI-friendly
non-interactive flags. Ensure the docs include the exact curl command string
being replaced and a short note pointing to where users can find the canonical
checksum/signature.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7c85ecb6-c0b7-419b-8a6b-17a79c0cbc2a
📒 Files selected for processing (9)
cli/agents.mdxcli/commands.mdxcli/configuration.mdxcli/file-mode.mdxcli/install.mdxcli/overview.mdxcli/quickstart.mdxdocs.jsonindex.mdx
Comment on lines
+52
to
+55
| ### `clean` | ||
|
|
||
| Remove all `.graph.*` files from the repository. | ||
|
|
There was a problem hiding this comment.
Clarify clean scope for three-file shards.
Line 54 says “Remove all .graph.* files,” but the docs now promote .calls.*, .deps.*, and .impact.* as the default shard set. Please explicitly state whether clean removes those too, so users don’t get conflicting expectations.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@cli/commands.mdx` around lines 52 - 55, The docs for the `clean` command
currently say “Remove all `.graph.*` files” which conflicts with the promoted
three-file shard set; update the `clean` command description so it explicitly
lists the full set of shard filenames it removes (e.g., `.graph.*`, `.calls.*`,
`.deps.*`, and `.impact.*`) or state that it removes any shard files matching
the pattern `.{graph,calls,deps,impact}.*`; change the line under the `clean`
heading to unambiguously reflect this behavior so users know exactly which files
`clean` deletes.
Comment on lines
+16
to
+25
| files: true # write .graph.* sidecars (or SUPERMODEL_FILES=false) | ||
| ``` | ||
|
|
||
| ## Environment variables | ||
|
|
||
| | Variable | Purpose | | ||
| |---|---| | ||
| | `SUPERMODEL_API_KEY` | API key. Overrides the config file. | | ||
| | `SUPERMODEL_API_BASE` | API base URL. Overrides the config file. | | ||
| | `SUPERMODEL_FILES` | Set to `false` to disable `.graph.*` writing globally. | |
There was a problem hiding this comment.
Sidecar terminology is a bit inconsistent.
Line 16 and Line 25 frame file writes as only .graph.*, while other new pages describe .calls.*/.deps.*/.impact.* as standard output. Suggest broadening wording to “graph sidecars” (including all shard formats).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@cli/configuration.mdx` around lines 16 - 25, Update the wording that
currently mentions only ".graph.*" (the "files: true" description and any
sentences that call out ".graph.*") to use the broader term "graph sidecars" and
explicitly note that this includes all shard formats such as ".graph.*",
".calls.*", ".deps.*", and ".impact.*"; ensure the phrase replaces any narrow
mentions so the Environment variables / SUPERMODEL_FILES description
consistently refers to "graph sidecars" (including those specific shard file
patterns).
| @@ -0,0 +1,86 @@ | |||
| --- | |||
| title: 'Installation' | |||
| description: 'Install the Supermodel CLI on macOS, Linux, or Windows' | |||
There was a problem hiding this comment.
Windows support is stated but not explicitly shown.
Line 3 says Windows is supported, but there’s no concrete Windows-native install example. Adding one explicit path (e.g., npm on PowerShell, or another official method) would remove ambiguity.
Also applies to: 15-27
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@cli/install.mdx` at line 3, Update the cli/install.mdx docs to include an
explicit Windows-native install example alongside the macOS/Linux lines: add a
PowerShell npm install snippet (e.g., "npm install -g `@supermodel/cli`" run in an
elevated PowerShell) and optionally a native package manager variant (winget or
choco) with the exact command to install the Supermodel CLI; place these
examples where the existing platform install commands appear so Windows is
unambiguous and mirrors the macOS/Linux examples already present.
| icon: 'terminal' | ||
| --- | ||
|
|
||
| The Supermodel CLI maps every file, function, and call relationship in your repo, then writes plain-text `.graph.*` sidecar files next to each source file. Your agent picks them up automatically through its normal file-reading tools — no prompt changes, no extra context windows, no agent-specific integration. |
There was a problem hiding this comment.
Onboarding claim conflicts with other new docs.
Line 7 says “no prompt changes,” but cli/quickstart.mdx (Line 50-56) and cli/file-mode.mdx (Line 71-77) recommend appending supermodel skill to agent instructions. Consider softening this line (for example: “works without deep agent-specific integrations, with optional prompt guidance”).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@cli/overview.mdx` at line 7, The sentence in overview.mdx claiming “no prompt
changes” conflicts with guidance in cli/quickstart.mdx and cli/file-mode.mdx
that recommend appending "supermodel skill" to agent instructions; update the
phrasing in overview.mdx (the line containing “no prompt changes, no extra
context windows, no agent-specific integration”) to a softened version such as
“works without deep agent-specific integrations, with optional prompt guidance”
so it accurately reflects that the CLI can be used out-of-the-box but may
benefit from optional prompt/appended instructions like `supermodel skill`.
Restructures the CLI tab to match the API reference style — each
command gets its own dedicated page. Drops the overview, file-mode,
agents, and configuration pages; the CLI is just a CLI, install
instructions and a quickstart are enough surrounding context.
Navigation:
Get started → install, quickstart
Commands → one page per subcommand (22 total, including the
bare `supermodel` watch daemon)
Each command page mirrors the structure used in IDE/terminal docs:
synopsis, description, flags table, examples, aliases.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@cli/commands/docs.mdx`:
- Line 6: The documentation uses a lowercase "markdown" in the phrase "converts
the returned code graph to markdown"; update that token to "Markdown" (capital
M) to follow proper noun/style conventions — locate the exact sentence in the
docs.mdx content and replace "markdown" with "Markdown" so the sentence reads
"converts the returned code graph to Markdown".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 5adc295a-0c31-4eec-9bbf-7d49368a3f74
📒 Files selected for processing (26)
cli/commands/analyze.mdxcli/commands/audit.mdxcli/commands/blast-radius.mdxcli/commands/clean.mdxcli/commands/compact.mdxcli/commands/dead-code.mdxcli/commands/docs.mdxcli/commands/find.mdxcli/commands/focus.mdxcli/commands/graph.mdxcli/commands/hook.mdxcli/commands/login.mdxcli/commands/logout.mdxcli/commands/mcp.mdxcli/commands/restore.mdxcli/commands/setup.mdxcli/commands/share.mdxcli/commands/skill.mdxcli/commands/status.mdxcli/commands/update.mdxcli/commands/version.mdxcli/commands/watch.mdxcli/install.mdxcli/quickstart.mdxdocs.jsonindex.mdx
✅ Files skipped from review due to trivial changes (24)
- cli/commands/hook.mdx
- cli/commands/logout.mdx
- cli/commands/skill.mdx
- cli/commands/clean.mdx
- cli/commands/analyze.mdx
- cli/commands/focus.mdx
- docs.json
- cli/commands/status.mdx
- cli/commands/update.mdx
- cli/commands/find.mdx
- cli/commands/share.mdx
- cli/install.mdx
- cli/quickstart.mdx
- cli/commands/watch.mdx
- cli/commands/login.mdx
- cli/commands/setup.mdx
- cli/commands/mcp.mdx
- cli/commands/blast-radius.mdx
- cli/commands/restore.mdx
- cli/commands/dead-code.mdx
- cli/commands/graph.mdx
- cli/commands/compact.mdx
- cli/commands/audit.mdx
- cli/commands/version.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- index.mdx
| description: 'Generate static architecture documentation for a repository' | ||
| --- | ||
|
|
||
| Generates a static HTML site documenting the architecture of a codebase. The command uploads the repository to the Supermodel API, converts the returned code graph to markdown, and builds a browsable static site with search, dependency graphs, taxonomy navigation, and SEO metadata. The site also emits machine-readable artifacts (JSON-LD and `LLMS.txt`) alongside the HTML. |
There was a problem hiding this comment.
Capitalize “Markdown” (proper noun).
Line [6] says “converts … to markdown”. For consistency/style (and per typical doclint expectations), it should be “Markdown”.
✅ Proposed fix
-Generates a static HTML site documenting the architecture of a codebase. The command uploads the repository to the Supermodel API, converts the returned code graph to markdown, and builds a browsable static site with search, dependency graphs, taxonomy navigation, and SEO metadata. The site also emits machine-readable artifacts (JSON-LD and `LLMS.txt`) alongside the HTML.
+Generates a static HTML site documenting the architecture of a codebase. The command uploads the repository to the Supermodel API, converts the returned code graph to Markdown, and builds a browsable static site with search, dependency graphs, taxonomy navigation, and SEO metadata. The site also emits machine-readable artifacts (JSON-LD and `LLMS.txt`) alongside the HTML.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Generates a static HTML site documenting the architecture of a codebase. The command uploads the repository to the Supermodel API, converts the returned code graph to markdown, and builds a browsable static site with search, dependency graphs, taxonomy navigation, and SEO metadata. The site also emits machine-readable artifacts (JSON-LD and `LLMS.txt`) alongside the HTML. | |
| Generates a static HTML site documenting the architecture of a codebase. The command uploads the repository to the Supermodel API, converts the returned code graph to Markdown, and builds a browsable static site with search, dependency graphs, taxonomy navigation, and SEO metadata. The site also emits machine-readable artifacts (JSON-LD and `LLMS.txt`) alongside the HTML. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...PI, converts the returned code graph to markdown, and builds a browsable static site wit...
(MARKDOWN_NNP)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@cli/commands/docs.mdx` at line 6, The documentation uses a lowercase
"markdown" in the phrase "converts the returned code graph to markdown"; update
that token to "Markdown" (capital M) to follow proper noun/style conventions —
locate the exact sentence in the docs.mdx content and replace "markdown" with
"Markdown" so the sentence reads "converts the returned code graph to Markdown".
jonathanpopham
added a commit
to supermodeltools/cli
that referenced
this pull request
Apr 29, 2026
* Link to CLI docs from the README Adds the new docs.supermodeltools.com/cli home as a prominent link near the top of the README and as a row in the Links table. The docs cover install, file mode, agent integration, configuration, and a full command reference — see supermodeltools/docs#7. * Point CLI docs link at install page
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs.jsonwith three groups (Get started, Guides, Reference)cli/covering install, quickstart, file mode, agents, configuration, and a full command referenceindex.mdx) now exposes the CLI alongside the API in aCardGroupPages were authored from authoritative
supermodel <cmd> --helpoutput and the v0.6.0 source tree (cmd/*.go). Includes theskillandupdatecommands (added in v0.6.0) and the three-file shard format.Test plan
mintlify devboots and the CLI tab renders/cli/overview→ siblings)<Steps>,<CardGroup>,<Tabs>-free) render correctlydocs.jsonJSON is valid (verified locally withpython3 -c "import json; json.load(open('docs.json'))")Summary by CodeRabbit