Skip to main content
Workspace commands talk to your running local service. Commands inside a registered project discover its identity from .flowfield/config.toml. Use --project ID when working elsewhere, and --help at any command level for its options.

Service and version

Global --port selects the service. --data-dir or FLOWFIELD_DATA_DIR selects storage; FLOWFIELD_PORT selects the client port.

Updates

status reads the service’s shared result, or the saved cache when the service is stopped. check requests a manual check from the running service and waits briefly for the result. Both accept --json; human update notices and errors use stderr. An unsuccessful manual check exits with an error. These commands do not install software or start a service. See installation for upgrade instructions and automatic checks.

Storage and recovery

Storage commands run offline and accept --json. Status and backup listing do not initialize or migrate the workspace. Recovery requires a stopped service and refuses to discard writes made since the snapshot. See local storage for automatic migrations, recovery limits and full backups.

Projects and guidance

project init /absolute/path adopts an existing directory. Initial --id, --name and --prefix override derived values. The three-letter task prefix locks after the first task. project guidance export --part coordinator prints the packaged skill without connecting to a service. project guidance remove removes unchanged owned content and preserves local edits.

Tasks and milestones

Use stable task keys or IDs. The coordinator prepares task definitions through MCP; CLI task operations expose the same workspace rules. Task dependencies and readiness are checked by the service.

Questions, execution and results

project workers run enables eligible Up next starts; pause leaves active workers running. task runs stop ATTEMPT_ID targets one attempt. Inspect task results review --help for exact-candidate approval and request-changes options; a result revision and candidate commit are required. task results retry-delivery --help describes recovery when approved code is blocked from reaching the checkout. Questions and replies preserve their task, attempt and result bindings. Answering does not enable a paused queue; inspecting a result does not approve it.

Project integration

Configure the target branch and trusted project checks to match your repository. Repeat --check for multiple commands; --setup adds dependency setup. Your coordinator can configure and validate richer environment and run-command settings through MCP.

Harness connections

See Codex for project setup and fresh-session verification.

Automation

Add --json to data commands for structured output. Errors go to stderr with a nonzero exit status. Versioned edits require the current revision; do not overwrite newer intent from an outdated read. Paged reads return cursors and truncation metadata: follow them rather than treating the first page as complete history.