Skip to content

docs: promote independent review headline #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Meru143 merged 1 commit into from
Apr 4, 2026
Merged

docs: promote independent review headline #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
<section class="hero">
<div class="copy-card">
<p class="eyebrow">Local-first AI review for serious codebases</p>
<h1>AI code review that actually understands your codebase.</h1>
<h1>Your coding agent should not grade its own homework.</h1>
<p class="lede">
Argus gives you an independent reviewer with structural maps, semantic
search, git history, and diff-aware analysis, so the model reviewing the
Expand Down Expand Up @@ -90,7 +90,7 @@ <h1>AI code review that actually understands your codebase.</h1>
<section id="why" class="section">
<div class="section-head">
<p class="eyebrow">Why Argus</p>
<h2>Your coding agent should not grade its own homework.</h2>
<h2>AI code review that actually understands your codebase.</h2>
<p>
Most AI review workflows reuse the same shallow context that produced the
patch. Argus takes the opposite stance: review should be independent,
Expand Down Expand Up @@ -175,9 +175,9 @@ <h2>Start with the package manager you already trust.</h2>
<div class="install-grid">
<article class="install-card">
<h3>npm</h3>
<pre><code>npx argus-ai init
<pre><code>npx argus init
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Use published package name in npx example

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 👍 / 👎.

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>
Comment on lines +178 to +180
Copy link

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines +178 to +180
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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").

</article>
<article class="install-card">
<h3>cargo</h3>
Expand Down
Loading