Skip to content

CLI Reference

Commands

codexspec init

Initialize a new CodexSpec project.

codexspec init [PROJECT_NAME] [OPTIONS]

Arguments:

Argument Description
PROJECT_NAME Name for your new project directory (use . or --here for the current dir)

Options:

Option Short Description
--here -h Initialize in the current directory
--ai -a AI assistant to use: claude, codex, or both (default: claude)
--lang -l Output (base) language; interaction/document/commit fall back to it (e.g., en, zh-CN, ja)
--interaction-lang Interaction language (LLM dialogue + codexspec CLI output); overrides --lang
--document-lang Document language (generated requirements/spec/plan/tasks); overrides --lang
--commit-lang Commit-message language; overrides --lang
--force -f Overwrite existing files and auto-confirm prompts; never regenerates config.yml
--no-git Skip git repository initialization
--debug -d Enable debug output

--lang sets the output base language; --interaction-lang, --document-lang, and --commit-lang override it for their dimension (each falls back to output, then en). See Internationalization for the full model.

First-time init in a TTY without --lang (and without all three dimension flags) prompts for a base language; in a non-TTY (CI/scripts) it defaults to enfully non-interactive. Re-running init preserves any language key you did not specify; --force never regenerates config.yml.

Examples:

# Create new project
codexspec init my-project

# Initialize in current directory
codexspec init . --ai claude

# One-time usage (no installation) — initialize for Codex CLI or both
uvx codexspec init . --ai codex
uvx codexspec init . --ai both

# Fully non-interactive: zh-CN base, English commit messages
codexspec init my-project --lang zh-CN --commit-lang en

# Set every dimension explicitly (scriptable, no prompts)
codexspec init my-project \
  --interaction-lang zh-CN --document-lang en --commit-lang en

codexspec check

Check for installed tools.

codexspec check

codexspec version

Display version information.

codexspec version

codexspec config

View or modify project configuration.

codexspec config [OPTIONS]

Options:

Option Short Description
--set-lang -l Set the output (base) language
--set-interaction-lang Set the interaction language (LLM dialogue + CLI output)
--set-document-lang Set the document language (generated spec/plan/tasks)
--set-commit-lang -c Set the commit-message language
--list-langs List all supported languages
--auto-next Toggle/set workflow.auto_next (bare toggles; or on/off)

Each --set-*-lang updates one language dimension; any dimension you do not set falls back to output, then en.