Make CLI quickstart watcher-first#13
Merged
jonathanpopham merged 4 commits intomainfrom Apr 30, 2026
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
WalkthroughReworks quickstart to run Changes
Sequence Diagram(s)(none — documentation-only change, no new multi-component control flow to diagram) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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: 1/5 review remaining, refill in 39 minutes and 54 seconds. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
index.mdx (1)
83-93:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winTerminology regression: “no daemon” should be “no watcher.”
This section reintroduces the old term, which conflicts with the watcher-first wording elsewhere.
Suggested consistency fix
-For one-shot analysis (no daemon), use: +For one-shot analysis (no watcher), use:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@index.mdx` around lines 83 - 93, The text uses inconsistent terminology: replace the phrase "no daemon" with "no watcher" in the section describing one-shot analysis so it matches the watcher-first language used elsewhere; update the sentence that currently reads "For one-shot analysis (no daemon), use:" to "For one-shot analysis (no watcher), use:" and scan nearby mentions of "daemon" in the same paragraph to ensure they use "watcher" instead (refer to the examples 'supermodel' and 'supermodel analyze' to locate the exact lines).cli/quickstart.mdx (1)
71-71:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winCommand reference sentence over-promises for an analyze-specific link.
Line 71 says “every command” but links to
/cli/commands/analyze(single command page). Please either point to a full commands index or narrow the wording. Same copy issue appears inindex.mdxLine 107.Suggested wording-only fix
-See the [command reference](/cli/commands/analyze) for every command, flag, and example. +See the [`analyze` command reference](/cli/commands/analyze) for flags and examples.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@cli/quickstart.mdx` at line 71, The sentence "See the [command reference](/cli/commands/analyze) for every command, flag, and example." over-promises because the link targets a single command; either update the link target to the full commands index (/cli/commands) or change the copy to reference the analyze command only (e.g., "See the [analyze command](/cli/commands/analyze) for flags and examples."). Apply the same change to the identical line in index.mdx so both files (the sentence text "See the [command reference](/cli/commands/analyze) for every command, flag, and example.") are consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@cli/quickstart.mdx`:
- Line 71: The sentence "See the [command reference](/cli/commands/analyze) for
every command, flag, and example." over-promises because the link targets a
single command; either update the link target to the full commands index
(/cli/commands) or change the copy to reference the analyze command only (e.g.,
"See the [analyze command](/cli/commands/analyze) for flags and examples.").
Apply the same change to the identical line in index.mdx so both files (the
sentence text "See the [command reference](/cli/commands/analyze) for every
command, flag, and example.") are consistent.
In `@index.mdx`:
- Around line 83-93: The text uses inconsistent terminology: replace the phrase
"no daemon" with "no watcher" in the section describing one-shot analysis so it
matches the watcher-first language used elsewhere; update the sentence that
currently reads "For one-shot analysis (no daemon), use:" to "For one-shot
analysis (no watcher), use:" and scan nearby mentions of "daemon" in the same
paragraph to ensure they use "watcher" instead (refer to the examples
'supermodel' and 'supermodel analyze' to locate the exact lines).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 04e94400-5d61-4baa-b7bf-43c1faf05ce6
📒 Files selected for processing (2)
cli/quickstart.mdxindex.mdx
There was a problem hiding this comment.
🧹 Nitpick comments (1)
cli/quickstart.mdx (1)
29-31: ⚡ Quick winPrevent duplicate agent instructions on repeated runs.
Using
>>every time will append another copy of the same prompt block toCLAUDE.md. A tiny clarification here would save users from instruction-file bloat.Proposed doc tweak
-supermodel skill >> CLAUDE.md -# or AGENTS.md, .cursorrules, etc. +supermodel skill > CLAUDE.md +# use >> only if you intentionally want to append again +# or AGENTS.md, .cursorrules, etc.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@cli/quickstart.mdx` around lines 29 - 31, The doc currently shows "supermodel skill >> CLAUDE.md" which will append the prompt every run and cause duplicate blocks; update the quickstart text to clarify use: instruct users to use a single right-angle redirect (>) to overwrite the file if they want only the latest prompt, or explicitly note that ">>" appends and should be used only when intentionally accumulating prompts (or instruct to manually remove existing blocks before re-running). Reference the exact example string "supermodel skill >> CLAUDE.md" so the change is made next to that line in the docs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@cli/quickstart.mdx`:
- Around line 29-31: The doc currently shows "supermodel skill >> CLAUDE.md"
which will append the prompt every run and cause duplicate blocks; update the
quickstart text to clarify use: instruct users to use a single right-angle
redirect (>) to overwrite the file if they want only the latest prompt, or
explicitly note that ">>" appends and should be used only when intentionally
accumulating prompts (or instruct to manually remove existing blocks before
re-running). Reference the exact example string "supermodel skill >> CLAUDE.md"
so the change is made next to that line in the docs.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1c130b6f-8207-4520-9299-f0537384a6df
📒 Files selected for processing (2)
cli/quickstart.mdxindex.mdx
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/quickstart.mdx`:
- Line 24: The sentence currently implies file-change updates happen
automatically; change it to explicitly state that live updates require either
installing the supermodel hook (via `supermodel hook`) to send notifications or
running the watcher with the `--fs-watch` flag, e.g., append a clause saying
"Note: file-change updates are driven by supermodel hook notifications unless
you enable the local filesystem watcher with `--fs-watch`" so users who skip
hook installation won't assume the watcher is broken.
- Around line 14-16: Update the wording that currently states "On first run,
`supermodel` opens the setup flow automatically." to align with the command
docs: clarify that setup is only invoked when no prior configuration exists (or
when running the separate setup command), and that the live graph watcher (the
daemon) only starts either after a completed setup or when the user explicitly
requests daemon mode (e.g., via the daemon flag); replace the unconditional
phrasing with a conditional sentence that mentions the separate setup command
and the daemon/--daemon behavior and keep the subsequent sentence about starting
the live graph watcher conditional on setup completion or explicit daemon
invocation.
🪄 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: 7a2e357d-efc7-40a3-ab0c-faf9ea16b359
📒 Files selected for processing (2)
cli/quickstart.mdxindex.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- index.mdx
Comment on lines
+14
to
+16
| On first run, `supermodel` opens the setup flow automatically. It authenticates you, confirms the repo, offers to install the Claude Code hook, and enables `.graph.*` sidecar files. | ||
|
|
||
| ```bash | ||
| supermodel login --token smsk_live_... | ||
| After setup, the same command starts the live graph watcher: |
There was a problem hiding this comment.
Align first-run setup wording with command docs
Line 14 currently reads as unconditional behavior, but your command references describe setup as a separate command and daemon mode separately. This contradiction can confuse first-time users about what actually happens when they run supermodel.
Suggested wording tweak
-On first run, `supermodel` opens the setup flow automatically. It authenticates you, confirms the repo, offers to install the Claude Code hook, and enables `.graph.*` sidecar files.
+If Supermodel is not configured yet, `supermodel` opens the setup flow first. It authenticates you, confirms the repo, offers to install the Claude Code hook, and enables `.graph.*` sidecar files.📝 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
| On first run, `supermodel` opens the setup flow automatically. It authenticates you, confirms the repo, offers to install the Claude Code hook, and enables `.graph.*` sidecar files. | |
| ```bash | |
| supermodel login --token smsk_live_... | |
| After setup, the same command starts the live graph watcher: | |
| If Supermodel is not configured yet, `supermodel` opens the setup flow first. It authenticates you, confirms the repo, offers to install the Claude Code hook, and enables `.graph.*` sidecar files. | |
| After setup, the same command starts the live graph watcher: |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@cli/quickstart.mdx` around lines 14 - 16, Update the wording that currently
states "On first run, `supermodel` opens the setup flow automatically." to align
with the command docs: clarify that setup is only invoked when no prior
configuration exists (or when running the separate setup command), and that the
live graph watcher (the daemon) only starts either after a completed setup or
when the user explicitly requests daemon mode (e.g., via the daemon flag);
replace the unconditional phrasing with a conditional sentence that mentions the
separate setup command and the daemon/--daemon behavior and keep the subsequent
sentence about starting the live graph watcher conditional on setup completion
or explicit daemon invocation.
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
supermodelfrom the reposupermodel analyzeinto a one-shot analysis sectionValidation
supermodelfirst-run behavior with an isolated HOMEsupermodelstarts the live watcher from a temp repo and cleans up on Ctrl+Csupermodel skill >> CLAUDE.mdin a temp reposupermodel analyze --no-shardsin a temp repojq . docs.jsongit diff --checkmintlify openapi-check openapi.yamlNote:
mintlify broken-linksstill reports the existing generated API reference false positives for/api-reference,/api-reference/data-plane/call-graph, and/api-reference/data-plane/domain-graph; those were already known and are not introduced by this change.Summary by CodeRabbit