Skip to content

Commit e2f329c

Browse files
committed
Adjust README quickstart for source installs
1 parent 0067a7f commit e2f329c

1 file changed

Lines changed: 16 additions & 7 deletions

File tree

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -105,24 +105,33 @@ That means the README, docs, and fork messaging are intentionally about the **pr
105105

106106
## Quickstart
107107

108-
If you are looking for the current Codex CLI install surface that this fork tracks, the familiar commands remain:
108+
If you want to use this fork from source, build the Rust workspace and install the resulting binary locally.
109109

110110
```shell
111-
# Install using npm
112-
npm install -g @openai/codex
111+
# Clone the fork and build the CLI
112+
git clone https://github.com/LEON-gittech/codex.git
113+
cd codex/codex-rs
114+
cargo build --release
113115
```
114116

117+
Then choose one of these install modes:
118+
119+
### Option A: replace your local `codex`
120+
115121
```shell
116-
# Install using Homebrew
117-
brew install --cask codex
122+
mkdir -p ~/.local/bin
123+
install -m 755 target/release/codex ~/.local/bin/codex
118124
```
119125

120-
Then run:
126+
### Option B: install this fork as `codex-dev`
121127

122128
```shell
123-
codex
129+
mkdir -p ~/.local/bin
130+
install -m 755 target/release/codex ~/.local/bin/codex-dev
124131
```
125132

133+
After that, run either `codex` or `codex-dev`, depending on which install path you chose.
134+
126135
## Docs
127136

128137
- [Contributing](./docs/contributing.md)

0 commit comments

Comments
 (0)