Skip to content

Commit 65e8efb

Browse files
Dikevinliyanbowne
andauthored
docs(readme): refine user guide tone and examples (#23)
Co-authored-by: liyanbowne <liyanbowne@gmail.com>
1 parent c0c6339 commit 65e8efb

3 files changed

Lines changed: 55 additions & 30 deletions

File tree

AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,8 @@ Detailed design notes live in `docs/internal/`.
4141
## References
4242

4343
- `docs/internal/codex-runtime-channels.md`
44+
45+
## User Docs
46+
47+
- Treat `README.md` and `README.zh-CN.md` as user-facing onboarding guides, not internal reference manuals.
48+
- Keep README sections short and task-oriented; prefer a few high-signal commands and examples over exhaustive command listings.

README.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
`codex-team` provides the `codexm` CLI for managing multiple Codex ChatGPT login snapshots on one machine.
66

7-
It is built for people who regularly switch between multiple Codex accounts and want a simpler workflow for:
7+
Use it when you regularly switch between multiple Codex accounts and want a simpler way to:
88

9-
- saving named account snapshots
10-
- switching the active `~/.codex/auth.json`
11-
- checking quota usage across saved accounts
12-
- automatically switching and restarting when the current account is exhausted
9+
- save named account snapshots
10+
- switch the active `~/.codex/auth.json`
11+
- check quota usage across saved accounts
12+
- automatically switch and restart when the current account is exhausted
1313

1414
## Platform support
1515

@@ -37,11 +37,7 @@ codexm add team1
3737
codexm launch --watch
3838
```
3939

40-
Typical flow:
41-
42-
- `codexm add <name>` opens the ChatGPT login flow and stores a named snapshot
43-
- `codexm launch --watch` starts Codex Desktop and keeps a background watcher running
44-
- when the active account is exhausted, the watcher can switch to the best saved account automatically
40+
This adds a couple of named snapshots, launches Codex Desktop, and keeps a watcher running in the background.
4541

4642
### Linux / WSL with Codex CLI
4743

@@ -57,11 +53,25 @@ In another terminal, start Codex through the wrapper:
5753
codexm run -- --model o3
5854
```
5955

60-
Typical flow:
56+
`codexm watch` monitors quota and can auto-switch accounts. `codexm run` wraps the `codex` CLI and restarts it when `~/.codex/auth.json` changes, so a long-running CLI session can follow account switches automatically.
57+
58+
## Example output
59+
60+
Redacted `codexm list` example:
61+
62+
```text
63+
$ codexm list
64+
Current managed account: plus-main
65+
Accounts: 2/3 usable | blocked: 1W 1, 5H 0 | plus x2, team x1
66+
Total: bottleneck 0.84 | 5H->1W 0.84 | 1W 1.65 (plus 1W)
67+
68+
NAME IDENTITY PLAN SCORE ETA 5H USED 1W USED NEXT RESET
69+
* plus-main acct...123 plus 72% 2.1h 58% 41% 04-14 18:30
70+
team-backup acct...987 team 64% 1.7h 61% 39% 04-14 19:10
71+
plus-old acct...456 plus 0% - 43% 100% 04-16 09:00
72+
```
6173

62-
- `codexm watch` monitors quota and can auto-switch accounts
63-
- `codexm run` wraps the `codex` CLI and restarts it when `~/.codex/auth.json` changes
64-
- this lets a long-running CLI session follow account switches automatically
74+
This is the main command to use when deciding which account to switch to next.
6575

6676
## Core commands
6777

@@ -95,18 +105,18 @@ Typical flow:
95105

96106
Use `codexm --help` for the full command reference.
97107

98-
## Notes
108+
## When should I use each command?
99109

100-
- `codexm list` is the best overview command when choosing which account to use next.
110+
- `codexm list` is the best overview when choosing the next account.
101111
- `codexm watch` is the automation loop that reacts to quota exhaustion.
102-
- `codexm run` is mainly useful for CLI workflows where you want the running `codex` process to follow account switches.
103-
- Use `--json` for scripting and `--debug` for stderr diagnostics.
112+
- `codexm run` is useful in CLI workflows where the running `codex` process should follow account switches.
113+
- Use `--json` for scripting and `--debug` for diagnostics.
104114

105115
For ChatGPT auth snapshots, `codex-team` can save and switch different users under the same ChatGPT account or workspace as separate managed entries when the local login tokens distinguish them.
106116

107117
## Shell completion
108118

109-
Generate a shell completion script and install it with your shell's standard mechanism:
119+
Generate a completion script and install it with your shell's standard mechanism:
110120

111121
```bash
112122
mkdir -p ~/.zsh/completions

README.zh-CN.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
`codex-team` 提供 `codexm` 命令,用来在一台机器上管理多个 Codex ChatGPT 登录快照。
66

7-
它适合经常在多个 Codex 账号之间切换的用户,主要解决这些问题
7+
如果你经常在多个 Codex 账号之间切换,它可以帮你更简单地
88

99
- 保存多个命名账号快照
1010
- 切换当前生效的 `~/.codex/auth.json`
@@ -37,11 +37,7 @@ codexm add team1
3737
codexm launch --watch
3838
```
3939

40-
典型流程:
41-
42-
- `codexm add <name>` 打开 ChatGPT 登录流程并保存一个命名快照
43-
- `codexm launch --watch` 启动 Codex Desktop,同时保持后台 watcher 运行
44-
- 当当前账号耗尽时,watcher 可以自动切换到最合适的已保存账号
40+
这会新增几个命名快照、启动 Codex Desktop,并在后台保持 watcher 运行。
4541

4642
### Linux / WSL + Codex CLI
4743

@@ -57,11 +53,25 @@ codexm watch
5753
codexm run -- --model o3
5854
```
5955

60-
典型流程:
56+
`codexm watch` 会持续监控 quota,并在耗尽时自动切号。`codexm run` 会包装 `codex` CLI,在 `~/.codex/auth.json` 变化后自动重启,这样长时间运行的 CLI 会话就能自动跟随切号。
57+
58+
## 输出示例
59+
60+
下面是一个脱敏后的 `codexm list` 示例:
61+
62+
```text
63+
$ codexm list
64+
Current managed account: plus-main
65+
Accounts: 2/3 usable | blocked: 1W 1, 5H 0 | plus x2, team x1
66+
Total: bottleneck 0.84 | 5H->1W 0.84 | 1W 1.65 (plus 1W)
67+
68+
NAME IDENTITY PLAN SCORE ETA 5H USED 1W USED NEXT RESET
69+
* plus-main acct...123 plus 72% 2.1h 58% 41% 04-14 18:30
70+
team-backup acct...987 team 64% 1.7h 61% 39% 04-14 19:10
71+
plus-old acct...456 plus 0% - 43% 100% 04-16 09:00
72+
```
6173

62-
- `codexm watch` 持续监控 quota,并在耗尽时自动切号
63-
- `codexm run` 包装 `codex` CLI,在 `~/.codex/auth.json` 变化后自动重启
64-
- 这样长时间运行的 CLI 会话可以自动跟随切号
74+
如果你想判断“接下来该切到哪个账号”,优先看这个命令。
6575

6676
## 常用命令
6777

@@ -95,7 +105,7 @@ codexm run -- --model o3
95105

96106
完整命令参考请使用 `codexm --help`
97107

98-
## 使用建议
108+
## 什么时候该用哪个命令?
99109

100110
- 如果你想判断“接下来该用哪个账号”,优先看 `codexm list`
101111
- 如果你想自动切号,使用 `codexm watch`

0 commit comments

Comments
 (0)