From 043f3fc00477c8a7767b01600983ea36d98f0e57 Mon Sep 17 00:00:00 2001 From: minhn4 Date: Wed, 22 Jul 2026 08:21:26 +0700 Subject: [PATCH 1/2] docs: rewrite npm package description and README The published codev-code npm page had a placeholder blurb. It now describes what the tool is, how to install and run it, and links the docs site, the fork repo, and upstream. No DIVERGENCES.md change: the existing publish.ts row already covers the embedded README/description. Co-Authored-By: Claude Fable 5 --- CHANGELOG.md | 8 ++++++++ packages/opencode/script/publish.ts | 31 +++++++++++++++++++++++++++-- 2 files changed, 37 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ca445455ec..0888939ab8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,14 @@ file is the human-readable summary of what changed and why. ## Unreleased +### Packaging + +- **Rewrote the npm package description and README** — the + [`codev-code`](https://www.npmjs.com/package/codev-code) npm page now + describes what the tool is, how to install and run it, and links the docs, + the fork repo, and upstream, replacing the placeholder blurb. + ([#119](https://github.com/quickbeard/codev-code/pull/119)) + ## 1.18.3-1 ### Sessions diff --git a/packages/opencode/script/publish.ts b/packages/opencode/script/publish.ts index 677016a2fe..8edb0e6976 100755 --- a/packages/opencode/script/publish.ts +++ b/packages/opencode/script/publish.ts @@ -48,7 +48,34 @@ await Bun.file(`./dist/${pkg.name}/README.md`).write( [ "# CoDev Code", "", - "Whatever I don't like about the upstream, I'll fix here—and push back upstream because I'm not a selfish brick.", + "An AI coding agent that lives in your terminal. CoDev Code is a fork of", + "[opencode](https://github.com/anomalyco/opencode) that tracks upstream closely", + "while carrying its own fixes and features.", + "", + "## Install", + "", + "```sh", + "npm install -g codev-code", + "```", + "", + "The install fetches a prebuilt binary for your platform (macOS, Linux, and", + "Windows on arm64/x64) and exposes it as the `codev` command.", + "", + "## Usage", + "", + "```sh", + "cd your-project", + "codev", + "```", + "", + "This opens the interactive terminal UI. Run `codev --help` for the full", + "command list, or `codev run \"...\"` for non-interactive use.", + "", + "## Links", + "", + "- Docs: https://netmind.viettel.vn/codev-landing-page/en/docs/", + "- Repository and issues: https://github.com/quickbeard/codev-code", + "- Upstream project: https://github.com/anomalyco/opencode", "", ].join("\n"), ) @@ -72,7 +99,7 @@ await Bun.file(`./dist/${pkg.name}/package.json`).write( JSON.stringify( { name: PUBLISH_NAME, - description: "Just another AI agent harness", + description: "AI coding agent for the terminal — an opencode fork with its own fixes and features", repository: { type: "git", url: "git+https://github.com/quickbeard/codev-code.git", From 367704cbd0a57a6b14f3bfb6f471662190f999a2 Mon Sep 17 00:00:00 2001 From: minhn4 Date: Wed, 22 Jul 2026 08:24:47 +0700 Subject: [PATCH 2/2] minor changes --- CHANGELOG.md | 8 -------- packages/opencode/script/publish.ts | 19 +++---------------- 2 files changed, 3 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0888939ab8..ca445455ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,14 +7,6 @@ file is the human-readable summary of what changed and why. ## Unreleased -### Packaging - -- **Rewrote the npm package description and README** — the - [`codev-code`](https://www.npmjs.com/package/codev-code) npm page now - describes what the tool is, how to install and run it, and links the docs, - the fork repo, and upstream, replacing the placeholder blurb. - ([#119](https://github.com/quickbeard/codev-code/pull/119)) - ## 1.18.3-1 ### Sessions diff --git a/packages/opencode/script/publish.ts b/packages/opencode/script/publish.ts index 8edb0e6976..7407b5c9f1 100755 --- a/packages/opencode/script/publish.ts +++ b/packages/opencode/script/publish.ts @@ -48,19 +48,12 @@ await Bun.file(`./dist/${pkg.name}/README.md`).write( [ "# CoDev Code", "", - "An AI coding agent that lives in your terminal. CoDev Code is a fork of", - "[opencode](https://github.com/anomalyco/opencode) that tracks upstream closely", - "while carrying its own fixes and features.", - "", "## Install", "", "```sh", - "npm install -g codev-code", + "npm i -g codev-code", "```", "", - "The install fetches a prebuilt binary for your platform (macOS, Linux, and", - "Windows on arm64/x64) and exposes it as the `codev` command.", - "", "## Usage", "", "```sh", @@ -69,13 +62,7 @@ await Bun.file(`./dist/${pkg.name}/README.md`).write( "```", "", "This opens the interactive terminal UI. Run `codev --help` for the full", - "command list, or `codev run \"...\"` for non-interactive use.", - "", - "## Links", - "", - "- Docs: https://netmind.viettel.vn/codev-landing-page/en/docs/", - "- Repository and issues: https://github.com/quickbeard/codev-code", - "- Upstream project: https://github.com/anomalyco/opencode", + 'command list, or `codev run "..."` for non-interactive use.', "", ].join("\n"), ) @@ -99,7 +86,7 @@ await Bun.file(`./dist/${pkg.name}/package.json`).write( JSON.stringify( { name: PUBLISH_NAME, - description: "AI coding agent for the terminal — an opencode fork with its own fixes and features", + description: "AI coding agent", repository: { type: "git", url: "git+https://github.com/quickbeard/codev-code.git",