24 lines
1.3 KiB
Markdown
24 lines
1.3 KiB
Markdown
# CodexHelper Wrapper — Usage and Design (Phase 1)
|
|
|
|
Overview
|
|
- CodexHelper wraps `codex`/`codex-cli` to provide modes, project scaffolding, and prompt composition.
|
|
- Governance: TDD, zero technical debt, plan-first via Questions → Proposal → Plan, production-ready always.
|
|
|
|
Status (Phase 1 in progress)
|
|
- Implemented: `new-mode` scaffolder (repo-only), CLI skeleton, guardrails.
|
|
- Pending (per plan): `new-project`, `run`, config precedence (YAML+yq).
|
|
- CI/Containers: Gitea Actions workflow in `.gitea/workflows/ci.yml`; local parity via `docker/compose.yml`.
|
|
|
|
CLI
|
|
- Help: `./CodexHelper --help`
|
|
- Repo-only: `./CodexHelper new-mode --name <ModeName> [--force]`
|
|
- Outside-repo (pending): `CodexHelper new-project --mode <ModeName> --name <project-name> --path <dir> [--force]`
|
|
- Outside-repo (pending): `CodexHelper run [--mode <ModeName>] [--prompt-file <file>] [--config <file>] [--sandbox <mode>] [--full-auto]`
|
|
|
|
Development
|
|
- Tests: run `scripts/test.sh` (uses bats if available, falls back to internal runner).
|
|
- Docker tests: `scripts/test.docker.sh` runs the same suite via Docker Compose.
|
|
- Audit: run `scripts/audit.sh` for governance/structure checks; CI runs it too.
|
|
- Follow TDD: write failing tests first, make them pass, refactor.
|
|
- Keep `docs/architecture.md` and README up to date as features land.
|