Skip to content

Commit 1c6e5ba

Browse files
committed
Merge remote-tracking branch 'origin/split/pr59-wrapper-docs' into release/all-open-v0.1.8
# Conflicts: # test/documentation.test.ts
2 parents 0c1c537 + b66c99e commit 1c6e5ba

3 files changed

Lines changed: 256 additions & 112 deletions

File tree

docs/reference/commands.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,14 @@ Compatibility aliases are supported:
5555

5656
---
5757

58+
## Compatibility and Non-TTY Behavior
59+
60+
- `codex` remains the primary wrapper entrypoint. It routes `codex auth ...` and the compatibility aliases to the multi-auth runtime, and forwards every other command to the official `@openai/codex` CLI.
61+
- In non-TTY or host-managed sessions, including `CODEX_TUI=1`, `CODEX_DESKTOP=1`, `TERM_PROGRAM=codex`, or `ELECTRON_RUN_AS_NODE=1`, auth flows degrade to deterministic text behavior.
62+
- The non-TTY fallback keeps `codex auth login` predictable: it defaults to add-account mode, skips the extra "add another account" prompt, and auto-picks the default workspace selection when a follow-up choice is needed.
63+
64+
---
65+
5866
## Dashboard Hotkeys
5967

6068
### Main Dashboard
@@ -80,15 +88,13 @@ Compatibility aliases are supported:
8088

8189
### Settings Screens
8290

83-
| Key | Action |
84-
| --- | --- |
85-
| `Enter` | Toggle/select/open |
86-
| `1-9` | Quick toggle for numbered options |
87-
| `S` | Save |
88-
| `R` | Reset |
89-
| `Q` | Back/cancel without saving draft changes |
90-
| `[` / `]` | Reorder fields in summary settings |
91-
| `+` / `-` | Adjust focused numeric backend setting |
91+
Settings screen hotkeys are panel-specific:
92+
93+
- Account List View: `Enter Toggle | Number Toggle | M Sort | L Layout | S Save | Q Back (No Save)`
94+
- Summary Line: `Enter Toggle | 1-3 Toggle | [ ] Reorder | S Save | Q Back (No Save)`
95+
- Menu Behavior: `Enter Select | 1-3 Delay | P Pause | L AutoFetch | F Status | T TTL | S Save | Q Back (No Save)`
96+
- Color Theme: `Enter Select | 1-2 Base | S Save | Q Back (No Save)`
97+
- Backend Controls: `Enter Open | 1-4 Category | S Save | R Reset | Q Back (No Save)`
9298

9399
---
94100

docs/reference/storage-paths.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,14 @@ Ownership note:
3535

3636
- `~/.codex/multi-auth/*` is managed by this project.
3737
- `~/.codex/accounts.json` and `~/.codex/auth.json` are managed by official Codex CLI.
38+
- The `codex` wrapper preserves that official CLI file-backed auth layout by forwarding non-auth commands with `-c cli_auth_credentials_store="file"`, unless the caller already set `cli_auth_credentials_store` explicitly.
39+
- Set `CODEX_MULTI_AUTH_FORCE_FILE_AUTH_STORE=0` to opt out of that wrapper-injected file-store override and leave the downstream CLI auth store untouched.
40+
41+
Compatibility note:
42+
43+
- This file-store forwarding keeps auth state readable from disk outside interactive terminals, so wrapper forwarding and non-TTY auth flows stay deterministic after the Ink migration.
44+
45+
> **Windows note:** The wrapper keeps the official Codex CLI file-store layout unchanged, so Windows `EPERM`/`EBUSY` retry handling still lives with the downstream CLI writes rather than this wrapper layer. Opting out with `CODEX_MULTI_AUTH_FORCE_FILE_AUTH_STORE=0` stops injecting the file-store override for future wrapper launches, but it does not rewrite or expose previously written CLI auth files beyond the standard `~/.codex/auth.json` and `~/.codex/accounts.json` locations.
3846
3947
---
4048

@@ -72,6 +80,33 @@ Examples:
7280

7381
---
7482

83+
## Named Backup Exports
84+
85+
Experimental named backup exports are written under the local plugin-owned backup namespace beside the active accounts file:
86+
87+
- global root: `~/.codex/multi-auth/backups/<name>.json`
88+
- project root: `~/.codex/multi-auth/projects/<project-key>/backups/<name>.json`
89+
90+
Rules:
91+
92+
- `.json` is appended when omitted
93+
- backup names may only contain letters, numbers, `_`, and `-`
94+
- path separators and `..` are rejected
95+
- `.rotate.`, `.tmp`, and `.wal` names are rejected
96+
- existing files are not overwritten unless a lower-level force path is used explicitly
97+
98+
---
99+
100+
## oc-chatgpt Target Paths
101+
102+
Experimental sync targets the companion `oc-chatgpt-multi-auth` storage layout:
103+
104+
- global target: `~/.opencode/openai-codex-accounts.json`
105+
- project target: `~/.opencode/projects/<project-key>/openai-codex-accounts.json`
106+
- target backups: `~/.opencode/backups/` or project-local `backups/` beside the target account file
107+
108+
---
109+
75110
## Verification Commands
76111

77112
```bash

0 commit comments

Comments
 (0)