Fix cua-cli README install instructions to use npm registry#34
Merged
Conversation
The package now publishes to npm, so the install instructions should use a registry install instead of running from source. Bump the version so the updated README is republished. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
🤖 Pulumi Neo didn't review this pull request: no Pulumi preview ran for it. Agentic reviews require a preview of the affected stacks (for example from your CI's |
|
Firetiger deploy monitoring skipped This PR didn't match the auto-monitor filter configured on your GitHub connection:
Reason: PR only modifies documentation and version bumps in To monitor this PR anyway, reply with |
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
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
@onkernel/cua-clinow publishes to npm, but the README rendered on the npm package page still tells users to clone the monorepo and run from source viatsx. This updates the install section to a normal registry install and bumps the version so the corrected README gets republished.packages/cli/README.md: replace the "Install (from the monorepo)" section (npm install +npx tsx packages/cli/src/cli.ts+ theCUA_REPOshell-function workaround) with a registry install —npm install -g @onkernel/cua-cli(ornpx @onkernel/cua-cli). The shell-function hack only existed to run from source and is no longer needed: the installedcuabin already runs in the caller's cwd. Added the Node >= 22.19.0 requirement.packages/cli/package.json: bump0.1.1→0.1.2. npm only refreshes the package-page README on a new publish, so a version bump is required to ship the doc fix.Releasing
Per
.github/workflows/release-cua-cli.yml, publish is triggered by pushing acua-cli/v0.1.2tag onmain(the workflow verifies the tag version matchespackage.jsonand that the tag is an ancestor ofmain). After this merges, tag the merge commit:Test plan
cua-cli/v0.1.2release publishes.npx @onkernel/cua-cli@0.1.2 --helpprints usage.🤖 Generated with Claude Code
Note
Low Risk
Documentation and version bump only; no runtime or CLI behavior changes.
Overview
Updates
packages/cli/README.mdso the npm package page no longer tells users to clone the monorepo and run viatsx. Install is nownpm install -g @onkernel/cua-cliornpx @onkernel/cua-cli, with an explicit Node >= 22.19.0 note; the oldCUA_REPOshell-function workaround is removed.Bumps
@onkernel/cua-clifrom 0.1.1 → 0.1.2 so a new publish refreshes the README on npm (tagcua-cli/v0.1.2per the release workflow).Reviewed by Cursor Bugbot for commit 387be05. Bugbot is set up for automated code reviews on this repo. Configure here.