Add CLI quickstart to the welcome page#8
Merged
jonathanpopham merged 2 commits intomainfrom Apr 29, 2026
Merged
Conversation
Verified against the actual CLI: ran 'supermodel analyze' on the cli repo (3207 nodes cached, 178 source files → 151 .graph.* sidecars) and inspected a real sidecar from cmd/login.graph.go. The quickstart leads with 'supermodel setup' because the wizard handles the entire onboarding in one command — auth → repo detect → hook offer → starts the watch daemon. Then shows what a real .graph.go sidecar looks like, and lists the common follow-up commands (dead-code, blast-radius, audit, find, focus).
WalkthroughReplaces the docs landing’s single “Where to start” framing with two entry paths: direct API usage and a CLI-based local analysis flow. Adds a full CLI quickstart covering install, Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
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: 2/5 reviews remaining, refill in 32 minutes and 41 seconds. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
index.mdx (1)
33-35: Add a quick safety note forcurl | sh.Using this as the first install path is convenient, but adding a short “inspect script before executing” note improves security posture without adding friction.
Suggested doc addition
```bash curl -fsSL https://supermodeltools.com/install.sh | sh+Tip: review the install script before piping to
shif your environment requires stricter controls.</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@index.mdxaround lines 33 - 35, Add a short safety note immediately after
the install snippet containing the commandcurl -fsSL https://supermodeltools.com/install.sh | shthat tells users to inspect the
script before piping tosh(e.g., "Tip: review the install script before
piping toshif your environment requires stricter controls"), keeping it
concise and non-blocking to preserve the convenience of the one-line install.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Inline comments:
In@index.mdx:
- Line 112: The link text over-promises by saying "every flag and example" but
points to the analyze command page; change the sentence "See the command
reference for every flag and example." to a more
accurate phrasing such as "See the command reference
for flags and examples for this command" or "See the command
reference for available flags and examples" so the claim
matches the /cli/commands/analyze target.- Around line 57-58: The sentence "After setup runs, every source file has a
sidecar with its call graph, dependencies, and blast-radius data" wrongly
implies sidecars are always generated; update this wording to be conditional to
reflect shard mode. Change that sentence to indicate sidecars are generated only
when the user enables shard mode (or when setup is run with shards), e.g.,
prefix with "When shard mode is enabled," or "If you run setup with shards," and
optionally add a brief note that running with --no-shards will skip sidecar
generation so readers who skip shard mode aren’t confused.
Nitpick comments:
In@index.mdx:
- Around line 33-35: Add a short safety note immediately after the install
snippet containing the commandcurl -fsSL https://supermodeltools.com/install.sh | shthat tells users to inspect the
script before piping tosh(e.g., "Tip: review the install script before
piping toshif your environment requires stricter controls"), keeping it
concise and non-blocking to preserve the convenience of the one-line install.</details> <details> <summary>🪄 Autofix (Beta)</summary> Fix all unresolved CodeRabbit comments on this PR: - [ ] <!-- {"checkboxId": "4b0d0e0a-96d7-4f10-b296-3a18ea78f0b9"} --> Push a commit to this branch (recommended) - [ ] <!-- {"checkboxId": "ff5b1114-7d8c-49e6-8ac1-43f82af23a33"} --> Create a new PR with the fixes </details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Organization UI **Review profile**: CHILL **Plan**: Pro **Run ID**: `2bd91798-4e95-4770-a761-46ed25e697e1` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 414f9366c8febb9c7a734e239f04fb94fd56d947 and c8e176bebe2e5453366808727706ada20c41cc89. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `index.mdx` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| | Find usages of a symbol | `supermodel find handleRequest` | | ||
| | Token-efficient context for one file | `supermodel focus path/to/file.go` | | ||
|
|
||
| See the [command reference](/cli/commands/analyze) for every flag and example. |
There was a problem hiding this comment.
Avoid over-promising on the command-reference link text.
Line 112 says “every flag and example” but links to analyze specifically. A small wording tweak keeps expectations accurate.
Suggested wording tweak
-See the [command reference](/cli/commands/analyze) for every flag and example.
+See the [`analyze` command reference](/cli/commands/analyze), then use the CLI Commands section for the rest.📝 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
| See the [command reference](/cli/commands/analyze) for every flag and example. | |
| See the [`analyze` command reference](/cli/commands/analyze), then use the CLI Commands section for the rest. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@index.mdx` at line 112, The link text over-promises by saying "every flag and
example" but points to the analyze command page; change the sentence "See the
[command reference](/cli/commands/analyze) for every flag and example." to a
more accurate phrasing such as "See the [command
reference](/cli/commands/analyze) for flags and examples for this command" or
"See the [command reference](/cli/commands/analyze) for available flags and
examples" so the claim matches the /cli/commands/analyze target.
Reinstalled the CLI (was on stale v0.5.1 — current latest is v0.6.10 on supermodeltools/cli) and re-ran every step: - All 22 documented subcommands are present in v0.6.10. - Every flag in the per-command pages matches `<cmd> --help` exactly. - `supermodel skill` exists and is real — added it to step 3. - `analyze --three-file` produces three separate files (.calls / .deps / .impact), not one .graph file. Replaced the single-file sample with the actual three-file output from `cmd/login.*.go` on the CLI repo (336 shards, 178 source files, 3173 nodes, 7195 relationships). Real sample is verbatim from running the binary, including the "MEDIUM" risk and "CoreConfig · SupermodelAPI" multi-domain format introduced in v0.6.x.
There was a problem hiding this comment.
♻️ Duplicate comments (2)
index.mdx (2)
68-69:⚠️ Potential issue | 🟡 MinorMake sidecar generation conditional in wording.
Line 68 still reads as guaranteed output, but Line 51 presents shard mode as an option. A small wording tweak avoids confusion for users who skip shard mode.
Suggested tweak
-After setup runs with `--three-file` (recommended), each source file gets three sidecars: +If you enable shard mode (for example with `--three-file`), each source file gets three sidecars:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@index.mdx` around lines 68 - 69, Change the definitive statement "After setup runs with `--three-file` (recommended), each source file gets three sidecars:" to a conditional phrasing that matches the earlier shard-mode option (line ~51); e.g., prefix with "When using `--three-file` (recommended)," or "If you run setup with `--three-file`," so it reads as a conditional result rather than a guaranteed output, ensuring consistency with the shard-mode description.
129-129:⚠️ Potential issue | 🟡 MinorAvoid over-promising on the analyze link scope.
Line 129 says “every flag and example,” but the link targets only the
analyzecommand page.Suggested tweak
-See the [command reference](/cli/commands/analyze) for every flag and example. +See the [`analyze` command reference](/cli/commands/analyze) for its flags and examples.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@index.mdx` at line 129, The sentence over-promises by saying “every flag and example” while linking only to /cli/commands/analyze; update the copy so it accurately describes the link target (e.g., change the text to "See the analyze command reference (/cli/commands/analyze) for its flags and examples" or, if you meant to cover all commands, change the href to the global command reference page); ensure you edit the sentence that currently reads "See the [command reference](/cli/commands/analyze) for every flag and example" to one of these two accurate alternatives.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@index.mdx`:
- Around line 68-69: Change the definitive statement "After setup runs with
`--three-file` (recommended), each source file gets three sidecars:" to a
conditional phrasing that matches the earlier shard-mode option (line ~51);
e.g., prefix with "When using `--three-file` (recommended)," or "If you run
setup with `--three-file`," so it reads as a conditional result rather than a
guaranteed output, ensuring consistency with the shard-mode description.
- Line 129: The sentence over-promises by saying “every flag and example” while
linking only to /cli/commands/analyze; update the copy so it accurately
describes the link target (e.g., change the text to "See the analyze command
reference (/cli/commands/analyze) for its flags and examples" or, if you meant
to cover all commands, change the href to the global command reference page);
ensure you edit the sentence that currently reads "See the [command
reference](/cli/commands/analyze) for every flag and example" to one of these
two accurate alternatives.
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
Adds an end-to-end CLI quickstart to the docs landing page so first-time visitors who want the local binary can get going without clicking through.
The flow leads with `supermodel setup` because the wizard handles authentication, repo detection, hook installation, and starts the watch daemon all in one command — verified by reading `internal/setup/wizard.go`.
Includes a real `.graph.go` sample from `cmd/login.graph.go` (produced by running the CLI on its own source tree) so readers see exactly what shard files contain. Closes the page with a follow-up command table (`dead-code`, `blast-radius`, `audit`, `find`, `focus`) pointing into the per-command reference.
Test plan
Summary by CodeRabbit