CLI
Run, inspect, validate, render, and automate WorkSpec projects from the terminal.
CLI overview
Choose a WorkSpec CLI command for validation, execution, inspection, rendering, migration, or formatting.
CLI installation and environment
Install the WorkSpec CLI and verify the installed package version.
Project source inputs
Reference for Starting State, executable source flags, time, seed, and work-budget CLI inputs.
workspec validate
Validate a Starting State document or a complete WorkSpec project.
workspec snapshot
Run a WorkSpec project and inspect its resolved observable state at one time.
workspec constraints
Run Constraints against one authoritative WorkSpec execution.
workspec render
Run a WorkSpec project and render one resolved state as standalone SVG.
workspec format
Parse and write a JSON file with WorkSpec CLI formatting.
workspec migrate
Migrate Previous UAW Syntax input to the historical WorkSpec 2.1 shape.
JSON output and automation
Consume WorkSpec CLI JSON envelopes in scripts and continuous integration.
Exit codes and failure policy
Reference for WorkSpec CLI success, result failure, and command failure statuses.
Executing project JavaScript from the CLI
Understand WorkSpec CLI confirmations before executing project JavaScript.
CLI command and option index
Generated index of WorkSpec CLI commands, inputs, options, confirmations, and JSON envelopes.