Conversation
📝 WalkthroughWalkthroughThe pull request updates Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
This PR updates the docs landing page messaging by swapping the hero headline and the “Why Argus” section title, and adjusts the npm install example to use the argus CLI name.
Changes:
- Promote “Your coding agent should not grade its own homework.” to the hero headline and move the prior hero headline to the “Why Argus” section.
- Update the npm snippet to reference
argusinstead ofargus-aiin the command examples.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <pre><code>npx argus init | ||
| export GEMINI_API_KEY=your-key | ||
| git diff HEAD~1 | npx argus-ai review --repo .</code></pre> | ||
| git diff HEAD~1 | npx argus review --repo .</code></pre> |
There was a problem hiding this comment.
The npm quickstart uses npx argus ... without first installing the argus-ai package locally. Since the published npm package name is argus-ai (and it provides a argus bin), this command will likely try to fetch a different package named argus and fail / run the wrong tool. Consider either (a) showing an explicit install step (so npx argus resolves from node_modules/.bin), or (b) using npx's package flag to run the argus binary from the argus-ai package.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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 `@docs/index.html`:
- Around line 178-180: Update the missing-binary user-facing message in the CLI
bootstrap script (the npm/bin/argus launcher) so it uses the same CLI name as
docs and examples: replace any occurrence of "npx argus-ai" in the error/help
output with "npx argus" and ensure both the binary name string and any related
usage/help variables in npm/bin/argus are consistent (search for the string
"argus-ai" and change to "argus").
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| <pre><code>npx argus init | ||
| export GEMINI_API_KEY=your-key | ||
| git diff HEAD~1 | npx argus-ai review --repo .</code></pre> | ||
| git diff HEAD~1 | npx argus review --repo .</code></pre> |
There was a problem hiding this comment.
Keep CLI naming consistent with runtime error guidance.
The docs now correctly use npx argus, but npm/bin/argus still tells users to run npx argus-ai when the binary is missing. That inconsistency can mislead users during onboarding.
🔧 Proposed follow-up fix in npm/bin/argus
- console.error(
- "argus binary not found. Run `npm install` or `npx argus-ai` to download it."
- );
+ console.error(
+ "argus binary not found. Run `npm install` or `npx argus` to download it."
+ );🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/index.html` around lines 178 - 180, Update the missing-binary
user-facing message in the CLI bootstrap script (the npm/bin/argus launcher) so
it uses the same CLI name as docs and examples: replace any occurrence of "npx
argus-ai" in the error/help output with "npx argus" and ensure both the binary
name string and any related usage/help variables in npm/bin/argus are consistent
(search for the string "argus-ai" and change to "argus").
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 21a1a7786a
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| <article class="install-card"> | ||
| <h3>npm</h3> | ||
| <pre><code>npx argus-ai init | ||
| <pre><code>npx argus init |
There was a problem hiding this comment.
The npm install snippet now calls npx argus ..., but this repo publishes the package as argus-ai (npm/package.json line 2) and only maps argus as its bin (line 13). npm exec/npx treats the first positional token as the package spec when --package is not provided (npm exec -- <pkg>[@<version>] ...), so on a clean environment npx argus resolves package argus rather than argus-ai; this can make the documented install path run the wrong package or fail.
Useful? React with 👍 / 👎.
Summary
Verification
Summary by CodeRabbit