Skip to content

Commit 23c0dc7

Browse files
committed
docs: updated documentation for describing tips and design decisions
1 parent ddc9dff commit 23c0dc7

1 file changed

Lines changed: 78 additions & 3 deletions

File tree

README.md

Lines changed: 78 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# odin-codex-plugin
2-
ODIN [for Codex CLI as a plugin] - Outline Driven development approach for agentic INtelligence
32

3+
**ODIN [for Codex CLI as a plugin]** - **O**utline **D**riven development approach for agentic **IN**telligence
44

5-
## Clean Install (Recommended)
5+
## TL;DR
6+
7+
### Clean Install (Recommended)
68

79
```bash
810
rm -rf ~/.codex/
@@ -11,11 +13,84 @@ git clone https://github.com/OutlineDriven/odin-codex-plugin ~/.codex
1113

1214
---
1315

14-
## Overwrite Install
16+
### Overwrite Install
1517

1618
```bash
1719
git clone https://github.com/OutlineDriven/odin-codex-plugin
1820
mv ./odin-codex-plugin/* ~/.codex/
1921
```
2022

2123
That easy.
24+
25+
---
26+
27+
## Tips
28+
29+
### Keep upgrade codex up-to-date
30+
31+
```bash
32+
npm i -g @openai/codex@latest
33+
```
34+
35+
- Due to codex’s features are upgraded in silent and sometimes they’re significantly effective, upgrade codex(-cli) on your host machine consistently.
36+
37+
### Set plan mode
38+
39+
- You can turn on plan mode on codex by `shift + tab` shortcut.
40+
41+
### Steering
42+
43+
```bash
44+
# it trigger `/prompts:askme` prompt, which is designed for gathering more context during planning
45+
askme
46+
```
47+
48+
- Don't need to interrupt by triggering `esc` or wait the plan is fully done. Sometime you feel codex ask you for gathering more context to make better plan.
49+
50+
## Design decisions and codex’s configurations
51+
52+
> Basically, this project already turned on efficient features of codex, somethings are experimental state but battle-tasted, in .codex/config.toml. This section is going to tell about the decisions.
53+
>
54+
55+
### [config.toml](https://www.notion.so/prravda/config.toml)
56+
57+
```toml
58+
model_reasoning_effort = "high"
59+
model_verbosity = "high"
60+
approval_policy = "on-request"
61+
sandbox_mode = "workspace-write"
62+
project_doc_fallback_filenames = ["CLAUDE.md"]
63+
model = "gpt-5.4"
64+
personality = "pragmatic"
65+
```
66+
67+
- `model_reasoning_effort`, and `model_verbosity` set high as default due to high performance.
68+
- `project_doc_fallback_filenames` are fallback constitution files. The type of this property is `list[str]`, so you can add `str` type element into this section like `["CLAUDE.md", "AGENTS.md", "CRUSH.md"]`.
69+
- If you want to reuse other constitutions, feel these props which you’re using before.
70+
- set `personality` as `pragmatic` due to save token(direct communication)
71+
- polished `compaction_prompt` for better context compaction.
72+
- `memories`: codex also supports detecting and saving user’s tastes.
73+
74+
```toml
75+
[agents]
76+
max_depth = 2
77+
max_threads = 96
78+
job_max_runtime_seconds = 36000 # Default: 1800 seconds
79+
```
80+
81+
- codex could call agent(s) in recursively, by following max_depth.
82+
- But if host machine or your quota is limited, set these values including max_depth appropriately as you want.
83+
84+
### [agents](https://www.notion.so/prravda/agents/)
85+
86+
```toml
87+
model = "gpt-5.3-codex-spark"
88+
```
89+
90+
- some `fast` agents baed on spark model. But this model is only available on ChatGPT pro subscription. So if you're not pro subscriber, change them into appropriate models.
91+
92+
```toml
93+
model = "gpt-5.1-codex-mini"
94+
```
95+
96+
- set `explore` agent use `gpt-5.1-codex-mini`, because they consume little quota buf sufficient for exploration.

0 commit comments

Comments
 (0)