Skip to content

Instructree v0.16.0 — one-command Codex setup doctor

Choose a tag to compare

@kotobuki09 kotobuki09 released this 25 Aug 23:08

One share-safe Codex setup doctor

instructree doctor composes the supported pieces of a Codex setup into one deterministic, pre-session report: project-root discovery, user instructions, the effective project instruction chain, supported user configuration, and skill health.

What's new

  • Add instructree doctor [cwd] [--home <home>] [--json] for one-command Codex setup diagnostics.
  • Respect supported project_doc_max_bytes, project_doc_fallback_filenames, and project_root_markers settings, including override precedence and the shared project-instruction byte budget.
  • Show the selected global instruction file, effective project files, disabled skills, duplicate skill names, metadata failures, scan errors, and approximate skill-list pressure.
  • Redact repository and home paths so both text and JSON reports are safe to share.
  • Fail closed when relevant TOML syntax is outside the supported parser subset instead of presenting a partial answer.
  • Document the boundary clearly: this is a static pre-session preview, not a live or resumed-session inspector.

This addresses the focused diagnostics need described in openai/codex#30788. The behavior is grounded in a source-pinned research note; current Codex source does not yet expose a dedicated debug agents-md subcommand.

Verification

  • 68 tests across Node.js 20, 22, and 24 on Linux, macOS, and Windows.
  • All 9 CI jobs, Instructree code scanning, and GitHub Pages passed on commit 0fe113f96aa1b67af0bac0109fb2f29b07a79c48.
  • Arbor development and fresh packed held-out evaluations both scored 100/100.
  • The exact 23-file release tarball installed and passed a marker/fallback/override/byte-budget/duplicate-skill fixture with zero private-path leaks.
  • SHA-256: 85ccba4a7d742f27bec54ca297760de201562112bdeff212d9ee365c38b3ec95.