Repository navigation
docs: add update-to-latest snippet to README install sections - #57
Conversation
Adds an explicit @latest update command and finalrun --version verify line to the install block in both the root README and packages/cli README, keeping the two in parity. Removes the "-g never updates" ambiguity users hit after a fresh install. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 26 minutes and 17 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughUpdated root and CLI package README files to pin the global Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
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.
🧹 Nitpick comments (2)
README.md (1)
45-48: Consider restructuring to separate initial install from update instructions.The current flow presents the initial install command (line 44) immediately followed by an update command (line 47) in the same code block. This may confuse first-time users who might think both commands are required for initial setup.
Suggested alternatives:
Separate sections for "Installation" and "Updating":
Install the npm package globally: ```sh npm install -g `@finalrun/finalrun-agent` finalrun --version # verifyTo update an existing installation to the latest release:
npm install -g `@finalrun/finalrun-agent`@latest finalrun --version # verifyOr clarify with inline context in a single block:
Install the npm package globally: ```sh # First-time install npm install -g `@finalrun/finalrun-agent` # To update existing installation to latest release npm install -g `@finalrun/finalrun-agent`@latest finalrun --version # verify installationEither approach would make it clearer which command applies to which use case.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 45 - 48, Split the combined install/update commands into distinct, clear instructions: create an "Installation" section with the first-time install command (npm install -g `@finalrun/finalrun-agent`) and verification (finalrun --version), and a separate "Updating" section that shows the update command (npm install -g `@finalrun/finalrun-agent`@latest) with verification; alternatively, keep one code block but add inline comments labeling which command is "First-time install" and which is "Update to latest" so readers aren’t confused by the current sequence.packages/cli/README.md (1)
45-48: Consider restructuring to separate initial install from update instructions.The current flow presents the initial install command (line 44) immediately followed by an update command (line 47) in the same code block, which may confuse first-time users about whether both commands are needed for initial setup.
See the similar comment on
README.mdfor suggested alternatives. Since the PR objectives indicate these files should be kept in parity, any restructuring should be applied consistently to both files.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/cli/README.md` around lines 45 - 48, Split the combined install/update snippet into two distinct sections: one for initial installation with the install command (npm install -g `@finalrun/finalrun-agent`@latest) and a separate “Update” section that shows the update command and verification (finalrun --version); update the README content so first-time users see only the install steps in the first code block and the update instructions in a later block, and apply the same restructuring to the other README to keep parity.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@packages/cli/README.md`:
- Around line 45-48: Split the combined install/update snippet into two distinct
sections: one for initial installation with the install command (npm install -g
`@finalrun/finalrun-agent`@latest) and a separate “Update” section that shows the
update command and verification (finalrun --version); update the README content
so first-time users see only the install steps in the first code block and the
update instructions in a later block, and apply the same restructuring to the
other README to keep parity.
In `@README.md`:
- Around line 45-48: Split the combined install/update commands into distinct,
clear instructions: create an "Installation" section with the first-time install
command (npm install -g `@finalrun/finalrun-agent`) and verification (finalrun
--version), and a separate "Updating" section that shows the update command (npm
install -g `@finalrun/finalrun-agent`@latest) with verification; alternatively,
keep one code block but add inline comments labeling which command is
"First-time install" and which is "Update to latest" so readers aren’t confused
by the current sequence.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 08c91166-4961-48d6-b9d8-15e49ec5fdd5
📒 Files selected for processing (2)
README.mdpackages/cli/README.md
Replaces the two-step install + update snippet with a single `npm install -g @finalrun/finalrun-agent@latest` line followed by `finalrun --version` to verify. Works the same for fresh installs and upgrades, so the separate update block is unnecessary. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary
@latestupdate command +finalrun --versionverify line to the install block in bothREADME.mdandpackages/cli/README.mdTest plan
🤖 Generated with Claude Code
Summary by CodeRabbit