diff --git a/README.md b/README.md index bd211ad..36c8943 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,12 @@ It does not store ChatGPT tokens in app files. ## Install -Use any supported package manager: +Public status on March 20, 2026: +- app is ready +- npm package is not published yet +- GitHub release assets are not published yet + +When the first public release is cut, use any supported package manager: ```bash npm i -g @dhruv2mars/codexchat @@ -28,9 +33,15 @@ bun install -g @dhruv2mars/codexchat pnpm add -g @dhruv2mars/codexchat ``` -First run downloads the native binary into `~/.codexchat/bin/`. First run downloads the native binary and pinned codex bridge into `~/.codexchat/bin/`. +Until then, run from source: + +```bash +bun install +cargo run -p codexchat-cli -- +``` + ## Quickstart ```bash diff --git a/packages/cli/README.md b/packages/cli/README.md index ac2e307..2ba48fb 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -4,6 +4,12 @@ Chat with ChatGPT from your terminal. ## Install +Public status on March 20, 2026: +- npm package is not published yet +- GitHub release assets are not published yet + +After the first public release: + ```bash npm i -g @dhruv2mars/codexchat ``` @@ -17,6 +23,13 @@ Release assets come from GitHub Releases for your platform. Auth runs through the official `codex app-server` bridge and ChatGPT sign-in. The app stores local config and thread history only. +Until the first release, use the repo directly: + +```bash +bun install +cargo run -p codexchat-cli -- +``` + Supported release binaries: - `darwin-arm64` - `darwin-x64` diff --git a/packages/cli/test/docs-contract.test.js b/packages/cli/test/docs-contract.test.js index 303e94c..99b5116 100644 --- a/packages/cli/test/docs-contract.test.js +++ b/packages/cli/test/docs-contract.test.js @@ -38,8 +38,11 @@ test("repo ships core oss docs and templates", () => { test("root readme documents supported install and update paths", () => { const readme = read(join(repoRoot, "README.md")); + assert.match(readme, /npm package is not published yet/i); + assert.match(readme, /GitHub release assets are not published yet/i); assert.match(readme, /npm i -g @dhruv2mars\/codexchat/); assert.match(readme, /bun install -g @dhruv2mars\/codexchat/); + assert.match(readme, /cargo run -p codexchat-cli --/); assert.match(readme, /codexchat update/); assert.match(readme, /First run downloads the native binary and pinned codex bridge/i); assert.match(readme, /codex app-server/i); @@ -50,7 +53,9 @@ test("root readme documents supported install and update paths", () => { test("package readme is npm-ready and package avoids blocked postinstall", () => { const packageReadme = read(join(packageRoot, "README.md")); assert.match(packageReadme, /@dhruv2mars\/codexchat/); + assert.match(packageReadme, /npm package is not published yet/i); assert.match(packageReadme, /bun install -g @dhruv2mars\/codexchat/); + assert.match(packageReadme, /cargo run -p codexchat-cli --/); assert.match(packageReadme, /codexchat update/); assert.match(packageReadme, /pinned `codex` bridge/i);