@loongphy/codex-auth-linux-x64 0.3.0-alpha.8 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -2
- package/bin/codex-auth +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -47,6 +47,21 @@ After that, you can use `codex-auth login`, or `codex-auth login --device-auth`
|
|
|
47
47
|
|
|
48
48
|
Detailed command documentation lives in [docs/commands/README.md](./docs/commands/README.md).
|
|
49
49
|
|
|
50
|
+
> [!NOTE]
|
|
51
|
+
> This documentation is based on **v0.3.x**. Some commands described here may not be available in the current release.
|
|
52
|
+
>
|
|
53
|
+
> To try the latest features, please install the alpha version via:
|
|
54
|
+
>
|
|
55
|
+
> ```bash
|
|
56
|
+
> npm install -g @loongphy/codex-auth@next
|
|
57
|
+
> ```
|
|
58
|
+
>
|
|
59
|
+
> If you want to downgrade to **v0.2.x**, you may need to manually update the `~/.codex/accounts/registry.json`:
|
|
60
|
+
>
|
|
61
|
+
> ```json
|
|
62
|
+
> "schema_version": 3
|
|
63
|
+
> ```
|
|
64
|
+
|
|
50
65
|
### Account Management
|
|
51
66
|
|
|
52
67
|
| Command | Description |
|
|
@@ -58,6 +73,8 @@ Detailed command documentation lives in [docs/commands/README.md](./docs/command
|
|
|
58
73
|
| [`codex-auth remove [--live] [--api\|--skip-api]`](./docs/commands/remove.md) | Remove accounts interactively |
|
|
59
74
|
| [`codex-auth remove <query> [<query>...]`](./docs/commands/remove.md) | Remove accounts by selector |
|
|
60
75
|
| [`codex-auth remove --all`](./docs/commands/remove.md) | Remove all stored accounts |
|
|
76
|
+
| [`codex-auth alias set <query> <alias>`](./docs/commands/alias.md) | Set an alias for an account |
|
|
77
|
+
| [`codex-auth alias clear <query>`](./docs/commands/alias.md) | Clear the alias for an account |
|
|
61
78
|
|
|
62
79
|
### Import and Maintenance
|
|
63
80
|
|
|
@@ -141,6 +158,10 @@ Verify with:
|
|
|
141
158
|
codex exec "say hello"
|
|
142
159
|
```
|
|
143
160
|
|
|
161
|
+
## Build a GUI with JSON
|
|
162
|
+
|
|
163
|
+
If you are building a GUI on top of the current `codex-auth` client, use the supported `--json` command variants to receive machine-readable results. See the [JSON API documentation](./docs/json-api.md) for supported commands and the compatibility contract.
|
|
164
|
+
|
|
144
165
|
## Disclaimer
|
|
145
166
|
|
|
146
167
|
This project is provided as-is and use is at your own risk.
|
|
@@ -148,8 +169,12 @@ This project is provided as-is and use is at your own risk.
|
|
|
148
169
|
**Usage Data Refresh Source:**
|
|
149
170
|
`codex-auth` supports two sources for refreshing account usage/usage limit information:
|
|
150
171
|
|
|
151
|
-
1. **API (default):** The tool makes direct HTTPS requests to OpenAI's endpoints using your account's access token. This enables both usage refresh and team name refresh.
|
|
172
|
+
1. **API (default):** The tool makes direct HTTPS requests to OpenAI's endpoints using your account's access token. This enables both usage refresh and team name refresh. `curl` must be available at runtime.
|
|
152
173
|
2. **Local-only:** With per-command `--skip-api`, the tool scans local `~/.codex/sessions/*/rollout-*.jsonl` files for usage data and skips team name refresh API calls. This mode is safer, but it can be less accurate because recent Codex rollout files often contain `rate_limits: null`, so the latest local usage limit data may lag by several hours.
|
|
153
174
|
|
|
154
175
|
**API Call Declaration:**
|
|
155
|
-
By using the default API-backed refresh, this tool will send your ChatGPT access token to OpenAI's servers
|
|
176
|
+
By using the default API-backed refresh, this tool will send your ChatGPT access token to OpenAI's servers for usage limit and team name refresh. The exact endpoints are:
|
|
177
|
+
- `GET https://chatgpt.com/backend-api/wham/usage`
|
|
178
|
+
- `GET https://chatgpt.com/backend-api/accounts`
|
|
179
|
+
|
|
180
|
+
This behavior may be detected by OpenAI and could violate their terms of service, potentially leading to account suspension or other risks. The decision to use this feature and any resulting consequences are entirely yours.
|
package/bin/codex-auth
CHANGED
|
Binary file
|