Skip to content

Add doctor diagnostics command #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ChengShiLiu16 wants to merge 1 commit into from
Closed

Add doctor diagnostics command #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ and this project does not yet follow semantic versioning (pre-1.0).

### Added

- `codex-shim doctor`, a read-only local diagnostics command covering Python,
dependencies, Codex CLI availability, settings, runtime files, daemon health,
passthrough readiness, proxy loopback bypass, and Codex config wiring with
stable OK/WARN/FAIL/INFO output and summary exit-code handling.
- Auto Router (`codex_shim/router.py`): an optional `Auto (smart routing)` picker
entry (slug `codex-auto`) that routes each task to the cheapest configured
model that can handle it. A cheap classifier model scores every candidate
Expand Down
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -887,6 +887,7 @@ codex-shim generate regenerate catalog/config without starting daemon
codex-shim start regenerate catalog and start local shim daemon
codex-shim enable start daemon and write managed ~/.codex/config.toml block
codex-shim status health check + model count
codex-shim doctor read-only local diagnostics report
codex-shim stop stop daemon
codex-shim disable remove managed config block and stop daemon
codex-shim restart stop, regenerate, and start daemon
Expand All @@ -906,8 +907,8 @@ codex-model [list|<slug>] shortcut for `codex-shim model …`

Global flags:

- `--settings <path>`: used by catalog/model/start/app/codex flows.
- `--port <port>`: used by daemon/provider flows.
- `--settings <path>`: used by catalog/model/start/app/codex/doctor flows.
- `--port <port>`: used by daemon/provider/doctor flows.

`patch-app` and `restore-app` always target `/Applications/Codex.app`, do not
use `--settings`, and exit with a clear error on Windows/Linux.
Expand Down Expand Up @@ -974,10 +975,18 @@ the shim, so a visited web page cannot drive them via DNS rebinding.
### Shim will not start

```bash
codex-shim doctor
codex-shim status
tail -n 80 .codex-shim/shim.log
```

`codex-shim doctor` prints a read-only diagnostics report grouped by section
(Python, dependencies, Codex CLI, settings, runtime files, daemon health,
passthrough availability, proxy bypass, and Codex config). It never writes
configuration, starts/stops the daemon, calls model providers, or prints API
keys/tokens. It exits 1 only when a hard `FAIL` is detected; warnings are meant
as local setup hints.

Common causes:

- Python is older than 3.11.
Expand Down
Loading