Skip to content

chore: update npm readme #50

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
quickbeard merged 2 commits into from
Jul 12, 2026
Merged

chore: update npm readme #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5dcfc8
chore: update npm readme
quickbeard Jul 12, 2026
ce1f021
minor changes
quickbeard Jul 12, 2026
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Notes:

- With 2FA-on-publish, npm may prompt once per package (13 of them). A granular automation token avoids that: `npm config set //registry.npmjs.org/:_authToken <token>`.
- The wrapper refuses to run when the version is already on npm. For a fork-only re-release between upstream syncs, add a numeric revision to the version in `packages/opencode/package.json` (e.g. `1.17.16-1`, then `1.17.16-2`) — the Nth fork build of that upstream release; the next sync takes upstream's value back. Semver sorts the suffixed form below the bare `1.17.16`, but installs follow the `latest` dist-tag, so that quirk is harmless.
- Verify after publishing: `npm view codev-code` and `npm install -g codev-code && codev --version`.
- Verify after publishing: `npm view codev-code` and `npm i -g codev-code && codev --version`.

## Syncing with upstream

Expand Down
6 changes: 2 additions & 4 deletions packages/opencode/script/publish.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,18 @@ await Bun.file(`./dist/${pkg.name}/README.md`).write(
[
"# CoDev Code",
"",
"The AI agent harness.",
"",
"The recommended install path is the CoDev hub, which also wires up the AI gateway:",
"",
"```sh",
"npm install -g codev-ai",
"npm i -g codev-ai",
"codevhub install",
"codev",
"```",
"",
"Direct install:",
"",
"```sh",
"npm install -g codev-code",
"npm i -g codev-code",
"codev",
"```",
"",
Expand Down
Loading