Skip to content

CLI Reference

← How It Works · Español


Global

bash
specflow --version
specflow --help

All commands accept -C, --cwd <dir> to target a directory other than the current one.


specflow init

Interactive guided install.

bash
specflow init [options]
OptionDescription
-C, --cwd <dir>Target directory (default: current)
--no-docsSkip .agents-docs/ scaffold
--dry-runPreview without writing files

specflow sync

Update core engine and installed IDE adapters. Never touches .agents-docs/.

bash
specflow sync [options]
OptionDescription
-C, --cwd <dir>Target directory
--dry-runPreview changes
-y, --yesAllow sync while a flow task is active

specflow status

Show installed version, adapter list, and flow state.

bash
specflow status [options]
OptionDescription
-C, --cwd <dir>Target directory

Exit code 1 if SpecFlow is not installed in the target directory.

Output includes: version comparison (up to date / outdated / not installed), installed adapters, whether flow is active, and locale config (locale=es or locale=en) when .specflow-config.json exists.


specflow doctor

Verify SpecFlow installation, gitignore, templates, and (when flow is active) required artifacts for the current phase.

bash
specflow doctor [options]
OptionDescription
-C, --cwd <dir>Target directory
--runExecute bash commands from .agents-docs/verification.md
--jsonMachine-readable output

Exit code 1 if any check has severity error. Warnings alone exit 0.

When flow is active, doctor validates phase.md and phase-specific files (task.md, plan.md or legacy sdd.md, tasks.md).


specflow linear setup

Configure optional Linear issue sync (Cursor MCP only).

bash
specflow linear setup
specflow linear setup --enable
specflow linear setup --disable

Writes .specflow-linear.json with state mapping (default: Todo → In Progress → Done). Requires the Linear plugin in Cursor.

Start a linked task: nueva tarea desde TEAM-123 or paste a Linear issue URL.


specflow tools

Manage IDE adapters.

specflow tools list

bash
specflow tools list [-C, --cwd <dir>]

Shows installed and available adapters from manifest.json.

specflow tools add

bash
specflow tools add [options]

Interactive. Installs adapter files for selected tools.

OptionDescription
-C, --cwd <dir>Target directory
--dry-runPreview changes

specflow tools remove

bash
specflow tools remove [options]

Interactive. Removes adapter files for selected tools.

OptionDescription
-C, --cwd <dir>Target directory
--dry-runPreview changes

Versioning workflow

bash
npx @ceatoleii/specflow status   # → up to date | outdated | not installed
npx @ceatoleii/specflow sync       # after npm update @ceatoleii/specflow

.specflow-version records the installed engine version. status tells you when to sync.


← How It Works · Project Layout →

Released under the MIT License.