codex-workspace-bootstrap

Preflight your repository before an AI coding agent touches it.

Windows-first. Local by default. CI-friendly. Designed for repositories used with Codex, Copilot, Cline, Claude Code, Gemini CLI, Continue, Cursor, and similar coding agents.

日本語ガイド · Examples · GitHub Action · Roadmap · Releases

Community-maintained project. Not an official OpenAI product and not affiliated with OpenAI.

The 20-second demo

py -m pip install codex-workspace-bootstrap
cwb preflight .

Typical output:

AI Repository Preflight
State: NEEDS ATTENTION
Project: Python
AI instructions: none detected
Audit: 10 passed, 4 warnings, 0 blocking
Next actions:
  [P1] Add repository instructions for AI coding agents -> cwb init-agents .
  [P2] Make the Codex CLI available when local Codex workflows are intended -> codex --version

Fix the highest-value gap:

cwb init-agents .
cwb preflight .

The goal is not a vanity score. The result is one of:

• READY — core repository signals and AI instructions are present, with no blocking finding;
• NEEDS ATTENTION — usable, but important repository or AI-instruction signals are missing;
• BLOCKED — a blocking finding such as a tracked secret-risk filename needs review.

What it checks

Repository readiness

• Git repository
• README
• license
• .gitignore
• common project manifests
• local Git / Python / Node.js / npm / PowerShell / WSL / Codex signals

AI instruction coverage

The preflight detects repository instruction/config signals for:

• Codex / OpenAI agents — AGENTS.md
• GitHub Copilot — repository instructions
• Cline
• Claude Code
• Gemini CLI
• Continue
• Cursor

It does not claim these files are correct merely because they exist. It tells you what was detected so a maintainer can review the actual instructions.

Risk signals

The audit warns about common secret-bearing filenames without printing their contents. When Git is available, it distinguishes tracked, ignored, and untracked/unknown candidates. Tracked risky filenames can become blocking findings in strict mode.

This is intentionally a lightweight preflight check, not a replacement for deep scanners such as Gitleaks or Trivy.

Why this exists

AI coding tools are good at editing code. They are not a substitute for repository hygiene.

Before handing a repository to an agent, maintainers still need answers to questions such as:

• Is this the right repository root?
• Is the expected toolchain available?
• Does the repository explain how to validate changes?
• Are AI instructions present?
• Are risky files accidentally tracked?
• Can CI surface the same checks for every pull request?

codex-workspace-bootstrap turns those questions into one repeatable preflight.

Short CLI

The package installs both command names:

cwb --version
codex-workspace-bootstrap --version

Use cwb for day-to-day work.

Commands

One-command preflight

cwb preflight .

Write reports for automation or review:

cwb preflight . --json preflight.json
cwb preflight . --markdown preflight.md

Use strict mode when blocking findings should return a non-zero exit code:

cwb preflight . --strict

Detailed audit

cwb audit .
cwb audit . --json audit.json
cwb audit . --sarif audit.sarif
cwb audit . --strict

Non-destructive doctor

cwb doctor .

doctor prints remediation guidance only. It does not install software or modify system configuration.

Generate AGENTS.md

cwb init-agents .

Generation is evidence-based: the tool cross-checks project manifests, package scripts, pytest configuration, and README commands. Plausible but unconfirmed commands are separated for maintainer review. Existing AGENTS.md files are never overwritten unless --force is explicit.

GitHub Action

The reusable Action is published on GitHub Marketplace.

- uses: actions/checkout@v7
- uses: actions/setup-python@v7
  with:
    python-version: "3.13"
- uses: kohli217/codex-workspace-bootstrap@v0.4.0
  with:
    path: .
    strict: "true"

The Action adds the preflight Markdown report to the GitHub Actions job summary, so maintainers get a readable readiness snapshot without digging through raw logs. Optional SARIF output can be uploaded to GitHub Code Scanning.

See docs/GITHUB_ACTION.md.

Where it fits

This project is a preflight layer, not an AI coding agent and not a deep security scanner.

The intent is to complement those tools, not replace them.

Safety model

• Core checks run locally.
• Suspected secret files are not opened or printed by the filename-risk check.
• Repository contents are not sent to a remote AI service by the core audit.
• Existing AGENTS.md files are protected unless overwrite is explicit.
• A passing preflight is evidence about the checks performed, not a security guarantee.

See SECURITY.md.

Maintainer workflow

The project itself uses issue → branch → pull request → CI → merge → release.

Automated validation includes:

• Windows and Ubuntu;
• Python 3.10 and 3.13;
• built-wheel smoke tests;
• Action self-tests;
• strict self-audit;
• CodeQL;
• Dependabot;
• SARIF validation;
• PyPI publishing through GitHub OIDC Trusted Publishing.

Install

PyPI:

py -m pip install codex-workspace-bootstrap

Pinned GitHub release artifact:

py -m pip install "https://github.com/kohli217/codex-workspace-bootstrap/releases/download/v0.4.0/codex_workspace_bootstrap-0.4.0-py3-none-any.whl"

Development

git clone https://github.com/kohli217/codex-workspace-bootstrap.git
cd codex-workspace-bootstrap
py -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install -e . pytest
pytest -q

Contributions and real-world usage reports are welcome. See CONTRIBUTING.md, SUPPORT.md, CODE_OF_CONDUCT.md, and docs/ADOPTION.md.

License

MIT. See LICENSE.