Skip to content

Commit abcca30

Browse files
authored
docs: update documentation to reflect Rust CLI release (#1440)
As promised on #1405, we are making the first official release of the Rust CLI as v0.2.0. As part of this move, we are making it available in Homebrew: Homebrew/homebrew-core#228615 Ultimately, we also plan to continue to make the CLI available in npm, as well, though brew is a bit nicer in that `brew install` will download only the binary for your platform whereas an npm module is expected to contain the binaries for _all_ supported platforms, so it is a bit more heavyweight. A big part of this change is updating the root `README.md` to document the behavior of the Rust CLI, which differs in a number of ways from the TypeScript CLI. The existing `README.md` is moved to `codex-cli/README.md` as part of this PR, as it is still applicable to that folder. As this is still early days for the Rust CLI, I encourage folks to provide feedback on the command line flags and configuration options.
1 parent 4cb3c76 commit abcca30

File tree

3 files changed

+937
-374
lines changed

3 files changed

+937
-374
lines changed

.github/workflows/ci.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,12 @@ jobs:
7474
GH_TOKEN: ${{ github.token }}
7575
run: pnpm stage-release
7676

77-
- name: Ensure README.md contains only ASCII and certain Unicode code points
77+
- name: Ensure root README.md contains only ASCII and certain Unicode code points
7878
run: ./scripts/asciicheck.py README.md
79-
- name: Check README ToC
79+
- name: Check root README ToC
8080
run: python3 scripts/readme_toc.py README.md
81+
82+
- name: Ensure codex-cli/README.md contains only ASCII and certain Unicode code points
83+
run: ./scripts/asciicheck.py codex-cli/README.md
84+
- name: Check codex-cli/README ToC
85+
run: python3 scripts/readme_toc.py codex-cli/README.md

0 commit comments

Comments
 (0)