Skip to content

Commit 21fe318

Browse files
committed
Clarify Codex workspace setup
1 parent 5ecedf0 commit 21fe318

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,29 @@ the durable service layer, and TradingCodex MCP is the execution boundary.
3232
## Quick Start
3333

3434
```bash
35-
python3.14 -m pip install tradingcodex
35+
python3.14 -m venv ~/.tradingcodex/venv
36+
~/.tradingcodex/venv/bin/python -m pip install --upgrade pip
37+
~/.tradingcodex/venv/bin/python -m pip install --upgrade tradingcodex
3638
mkdir -p ~/tradingcodex-workspaces/apple-research
3739
cd ~/tradingcodex-workspaces/apple-research
38-
tcx init .
40+
~/.tradingcodex/venv/bin/tcx init .
3941
./tcx doctor
4042
```
4143

44+
To install from the GitHub repository instead of PyPI, replace the package
45+
install line with:
46+
47+
```bash
48+
~/.tradingcodex/venv/bin/python -m pip install --upgrade \
49+
"tradingcodex @ git+https://github.com/monarchjuno/tradingcodex.git@main"
50+
```
51+
52+
Keep the virtual environment outside the generated workspace. `tcx init .`
53+
expects the target directory to be empty, and the generated `./tcx` wrapper will
54+
remember the Python interpreter that created it. The package registers a `tcx`
55+
console script inside the virtual environment; the commands above call
56+
`~/.tradingcodex/venv/bin/tcx` directly so setup does not depend on shell `PATH`.
57+
4258
Start an orchestrated Codex workflow from the generated workspace:
4359

4460
```text

0 commit comments

Comments
 (0)