Skip to content

docs: add update-to-latest snippet to README install sections - #57

Merged
droid-ash merged 3 commits into
mainfrom
worktree-cryptic-imagining-teapot
Apr 5, 2026
Merged

droid-ash merged 3 commits into
mainfrom
worktree-cryptic-imagining-teapot

Conversation

@droid-ash

@droid-ash droid-ash commented Apr 5, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Append an explicit @latest update command + finalrun --version verify line to the install block in both README.md and packages/cli/README.md
  • Keeps the two READMEs in parity and removes the "-g never updates" ambiguity users hit after a fresh install

Test plan

  • Diff install blocks across both READMEs — byte-identical
  • Visual review of rendered markdown on GitHub

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Installation instructions updated to explicitly install the CLI at the latest published version (uses @latest) for clearer upgrade behavior.
    • Added a post-install verification step to check the installed CLI version, improving confidence that the tool was installed or updated successfully.

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>
@coderabbitai

coderabbitai Bot commented Apr 5, 2026 •

Copy link
Copy Markdown

Warning

Rate limit exceeded

@droid-ash has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 26 minutes and 17 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b733db65-6361-4f3f-acf1-053c7a9778f7

📥 Commits

Reviewing files that changed from the base of the PR and between 54c9f5b and 8622fba.

📒 Files selected for processing (2)
  • README.md
  • packages/cli/README.md
📝 Walkthrough

Walkthrough

Updated root and CLI package README files to pin the global @finalrun/finalrun-agent install to @latest and add a finalrun --version verification step immediately after installation. No other commands or workflows were modified.

Changes

Cohort / File(s) Summary
Root README
README.md
Changed global install snippet to npm install -g @finalrun/finalrun-agent@latest and added finalrun --version verification command.
CLI Package README
packages/cli/README.md
Same update to package README: pin global install to @latest and add finalrun --version verification step.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • arnoldlaishram

Poem

🐇 I hopped through docs to make them right,
Added @latest and a version light,
One tiny check to prove it’s true,
CLI’s ready — now go, woo-hoo! 🎉

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main change: adding @latest to the npm install command and including a version verification step in README install sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch worktree-cryptic-imagining-teapot

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@droid-ash
droid-ash requested a review from arnoldlaishram April 5, 2026 19:04
@droid-ash droid-ash self-assigned this Apr 5, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 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:

  1. Separate sections for "Installation" and "Updating":

    Install the npm package globally:
    
    ```sh
    npm install -g `@finalrun/finalrun-agent`
    finalrun --version     # verify

    To update an existing installation to the latest release:

    npm install -g `@finalrun/finalrun-agent`@latest
    finalrun --version     # verify
    
    
  2. Or 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 installation
    
    

Either 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.md for 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

📥 Commits

Reviewing files that changed from the base of the PR and between 496a4d6 and 31139b7.

📒 Files selected for processing (2)
  • README.md
  • packages/cli/README.md

droid-ash and others added 2 commits April 5, 2026 12:06
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>
@droid-ash
droid-ash merged commit ce912c1 into main Apr 5, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant