Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
13 changes: 13 additions & 0 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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`
Expand Down
5 changes: 5 additions & 0 deletions packages/cli/test/docs-contract.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -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);

Expand Down
Loading