1212
1313<div align =" center " >
1414 <a href =" #quick-start " >Quick Start</a > |
15+ <a href =" installation.md " >Installation</a > |
1516 <a href =" #agent-topology " >Agent Topology</a > |
1617 <a href =" #architecture " >Architecture</a > |
1718 <a href =" #execution-boundary " >Execution Boundary</a > |
@@ -31,82 +32,28 @@ the durable service layer, and TradingCodex MCP is the execution boundary.
3132
3233## Quick Start
3334
34- For Codex agents setting up ` monarchjuno/tradingcodex ` from a GitHub URL: this
35- source repository is not the final workspace. Use it only as a package source if
36- needed, then create a separate generated TradingCodex workspace with the
37- installer below.
35+ Codex agents: do not clone this source repository for installation. Run the
36+ installer from the empty workspace the user wants configured.
3837
39- Create an empty workspace directory, then bootstrap TradingCodex :
38+ Install TradingCodex into the current workspace :
4039
4140``` bash
42- mkdir -p ~ /tradingcodex-workspaces/apple-research
43- cd ~ /tradingcodex-workspaces/apple-research
41+ cd /path/to/empty-workspace
4442curl -fsSL https://raw.githubusercontent.com/monarchjuno/tradingcodex/main/install.sh | sh -s -- .
4543```
4644
47- The installer renders a Codex-ready workspace, runs ` ./tcx doctor ` , and records
48- project MCP config. A directory with only ` .git ` already initialized is fine.
49-
50- If you need the current GitHub ` main ` source instead of the PyPI package:
51-
52- ``` bash
53- curl -fsSL https://raw.githubusercontent.com/monarchjuno/tradingcodex/main/install.sh | sh -s -- --from-github .
54- ```
55-
56- Source checkouts of this repository are for development. Generated TradingCodex
57- workspaces are separate Codex projects.
58-
59- Direct ` uvx ` equivalent:
60-
61- ``` bash
62- UV_NO_CACHE=1 uvx --isolated --refresh --python 3.14 --from tradingcodex python -m tradingcodex_cli init . && ./tcx doctor
63- ```
64-
65- For repeated workspace creation, installing ` tcx ` as a user-level tool is still
66- available:
67-
68- ``` bash
69- uv python install 3.14 && uv tool install --python 3.14 tradingcodex && uv tool update-shell
70- ```
71-
72- Generated ` .codex/config.toml ` starts TradingCodex MCP with ` uvx ` , using the
73- same package spec recorded at bootstrap time. That MCP startup also autostarts
74- the experimental local Django dashboard service.
45+ After installation, fully quit and restart Codex, then open the generated
46+ workspace and start from a new thread so project MCP config is reloaded.
7547
7648Start an orchestrated Codex workflow from the generated workspace:
7749
7850``` text
7951$orchestrate-workflow analyze Apple with public equity research, valuation, portfolio, and risk review
8052```
8153
82- Open the workspace in Codex and trust the project. The generated project MCP
83- config starts TradingCodex MCP and the local dashboard service together.
84-
85- After Codex connects, these experimental local service surfaces are available:
86-
87- - ` http://127.0.0.1:8000/ ` for the work-in-progress visual harness dashboard
88- - ` http://127.0.0.1:8000/admin/ ` for the work-in-progress Django operations console
89-
90- For CLI-only use outside Codex, the experimental dashboard service can still be
91- started manually:
92-
93- ``` bash
94- ./tcx service runserver
95- ```
96-
97- Inspect the local MCP surface:
98-
99- ``` bash
100- printf ' {"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}\n' | ./tcx mcp stdio
101- ```
102-
103- Create and search DB-backed research memory:
104-
105- ``` bash
106- ./tcx research create --markdown-file note.md --id note-1 --title " Research Note"
107- ./tcx research search " gross margin"
108- ./tcx research export note-1
109- ```
54+ See [ installation.md] ( https://github.com/monarchjuno/tradingcodex/blob/main/installation.md )
55+ for GitHub-main installs, direct ` uvx ` , MCP/service details, and CLI smoke
56+ checks.
11057
11158## Agent Topology
11259
0 commit comments