You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-19Lines changed: 29 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,12 @@
4
4
5
5
`codex-team` provides the `codexm` CLI for managing multiple Codex ChatGPT login snapshots on one machine.
6
6
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:
8
8
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
13
13
14
14
## Platform support
15
15
@@ -37,11 +37,7 @@ codexm add team1
37
37
codexm launch --watch
38
38
```
39
39
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.
45
41
46
42
### Linux / WSL with Codex CLI
47
43
@@ -57,11 +53,25 @@ In another terminal, start Codex through the wrapper:
57
53
codexm run -- --model o3
58
54
```
59
55
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
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
+
```
61
73
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.
65
75
66
76
## Core commands
67
77
@@ -95,18 +105,18 @@ Typical flow:
95
105
96
106
Use `codexm --help` for the full command reference.
97
107
98
-
## Notes
108
+
## When should I use each command?
99
109
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.
101
111
-`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.
104
114
105
115
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.
106
116
107
117
## Shell completion
108
118
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:
0 commit comments