Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/8BitTacoSupreme/flowstate/llms.txt

Use this file to discover all available pages before exploring further.

flowstate status reads flowstate.json and renders a Rich table showing the current state of every tool in the pipeline. Use it after running flowstate init to confirm which steps completed, which are blocked, and what artifacts were produced.

​
Synopsis

flowstate status [OPTIONS]

​
Options

​
--root PATH
string
default:"."
Project root directory. flowstate status reads flowstate.json from this path.

​
Output

​
Status table

The main output is a Rich table with five columns:
ColumnDescription
ToolThe pipeline tool name: research, strategy, gsd, or discipline
PhaseHuman-readable phase label: Research, Strategy, Management, or Discipline
StatusCurrent tool state (see values below)
ArtifactsComma-separated list of artifact paths produced by this tool, or ---
ErrorError message if the tool is blocked, or ---

​
Status values

ValueMeaning
readyTool has not yet been run
runningTool is currently executing (or was interrupted mid-run)
completedTool ran successfully
blockedTool failed; see the Error column for details

​
Example output

┌────────────────────────────────────────────────────────────────────────┐
│                          FlowState Status                               │
├──────────────┬──────────────┬───────────┬────────────┬─────────────────┤
│ Tool         │ Phase        │ Status    │ Artifacts  │ Error           │
├──────────────┼──────────────┼───────────┼────────────┼─────────────────┤
│ research     │ Research     │ completed │ research/… │ ---             │
│ strategy     │ Strategy     │ completed │ research/… │ ---             │
│ gsd          │ Management   │ completed │ .planning… │ ---             │
│ discipline   │ Discipline   │ completed │ ---        │ ---             │
└──────────────┴──────────────┴───────────┴────────────┴─────────────────┘

​
Context files and artifacts

Below the table, flowstate status prints two additional sections when available:
  • Context files — the five files written during context generation, e.g. .planning/PROJECT.md, .claude/CLAUDE.md
  • Artifacts — named output files keyed by type, e.g. research_report: research/report.md and strategy_report: research/strategy.md
At the bottom of the output, the project name and path to the state file are shown: 
Project: my-project
State file: /path/to/project/flowstate.json

​
Example

flowstate status

flowstate status --root ./my-project

​
Notes

  • flowstate status is read-only — it never modifies flowstate.json.
  • If flowstate.json does not exist yet, run flowstate init first to initialize the project.
  • A tool in running state that is not actively executing indicates a previous run was interrupted. Re-run flowstate init --skip-interview to continue from where it left off.

Build docs developers (and LLMs) love

Get started for freeTalk to us