Skip to content

Fix cua-cli README install instructions to use npm registry#34

Merged
rgarcia merged 1 commit into
mainfrom
hypeship/cua-cli-readme-npm-install
Jun 22, 2026
Merged

Fix cua-cli README install instructions to use npm registry#34
rgarcia merged 1 commit into
mainfrom
hypeship/cua-cli-readme-npm-install

Conversation

@rgarcia

@rgarcia rgarcia commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Summary

@onkernel/cua-cli now publishes to npm, but the README rendered on the npm package page still tells users to clone the monorepo and run from source via tsx. 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 + the CUA_REPO shell-function workaround) with a registry install — npm install -g @onkernel/cua-cli (or npx @onkernel/cua-cli). The shell-function hack only existed to run from source and is no longer needed: the installed cua bin already runs in the caller's cwd. Added the Node >= 22.19.0 requirement.
  • packages/cli/package.json: bump 0.1.10.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 a cua-cli/v0.1.2 tag on main (the workflow verifies the tag version matches package.json and that the tag is an ancestor of main). After this merges, tag the merge commit:

git tag cua-cli/v0.1.2 <merge-commit>
git push origin cua-cli/v0.1.2

Test plan

  • Confirm the rendered README on the npm page shows the registry install after the cua-cli/v0.1.2 release publishes.
  • npx @onkernel/cua-cli@0.1.2 --help prints usage.

🤖 Generated with Claude Code


Note

Low Risk
Documentation and version bump only; no runtime or CLI behavior changes.

Overview
Updates packages/cli/README.md so the npm package page no longer tells users to clone the monorepo and run via tsx. Install is now npm install -g @onkernel/cua-cli or npx @onkernel/cua-cli, with an explicit Node >= 22.19.0 note; the old CUA_REPO shell-function workaround is removed.

Bumps @onkernel/cua-cli from 0.1.1 → 0.1.2 so a new publish refreshes the README on npm (tag cua-cli/v0.1.2 per the release workflow).

Reviewed by Cursor Bugbot for commit 387be05. Bugbot is set up for automated code reviews on this repo. Configure here.

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

pulumi Bot commented Jun 22, 2026

Copy link
Copy Markdown

🤖 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 pulumi preview).

@rgarcia rgarcia marked this pull request as ready for review June 22, 2026 22:19
@rgarcia rgarcia merged commit 1121e22 into main Jun 22, 2026
5 checks passed
@firetiger-agent

Copy link
Copy Markdown

Firetiger deploy monitoring skipped

This PR didn't match the auto-monitor filter configured on your GitHub connection:

PRs in the kernel, infra, hypeman, and hypeship repos. kernel is a ~mono repo with many logical services underneath, ensure to focus on the implicated service for the PR

Reason: PR only modifies documentation and version bumps in cua-cli package; no infrastructure, deployment, or service logic changes that would warrant deploy monitoring.

To monitor this PR anyway, reply with @firetiger monitor this.

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