NPM wrapper command
workspai goal
Compile a plain-language engineering intent into a scope-bound, evidence-pinned Goal Pack and portable agent handoff without mutating source.
- Category
- NPM wrapper
- Workspace Intelligence
- No
- Produced artifacts
- 2
- Related contracts
- 4
- Registration
- commander
- Registered options
- 15
Operational role
This purpose is versioned in the CLI runtime command surface. It is not inferred from page copy or a generic command template.
Canonical invocation
This invocation is derived from the runtime command surface. Commands with a registered intelligence execution include their canonical evidence-producing flags.
npx workspai goal <intent> --jsonRuntime signature
Arguments, aliases, and options come from the versioned snapshot of the live Commander tree emitted by the CLI. Contract-declared delegated commands intentionally expose only their canonical invocation.
Arguments and aliases
Aliases: None
- intent · optional
Options
- --workspace <path>
- --scope <scope>
- --runtime <runtime>
- --for-agent <consumer>
- --max-attempts <count>
- --refresh
- --dry-run
- --status [goal-id]
- --list
- --activate <goal-id>
- --cancel <goal-id>
- --prepare <goal-id>
- --verify <goal-id>
- --no-run
- --json
Output modes
Output formats are contract-declared. Raw renderer text and structured JSON are separate integration boundaries.
| Selector | Format | Media type |
|---|---|---|
| --json | json | application/json |
Exit semantics
Automation should use these process-level rules together with the structured report verdict.
Default
A contract-valid Goal Pack returns exit code 0, including explicit needs-confirmation, needs-evidence, or blocked planning states.
Strict
Not applicable; Goal planning does not execute or verify source changes.
Failure
Resolution, freshness, contract, integrity, or publication failure returns exit code 1.
Contract relationships
Capability contracts govern whether the command exists; artifact contracts govern the structured output it produces.
Produced artifacts
Artifacts are durable machine-readable outputs. Their schema, path, and producer relationship must remain stable across CLI, CI, IDE, MCP, and agent consumers.
| Artifact | Schema version | Contract |
|---|---|---|
| .workspai/goals/index.json | workspai.goal-index.v1 | contracts/workspace-intelligence/goal-index.v1.json |
| .workspai/reports/goal-pack-last-run.json | workspai.goal-pack.v1 | contracts/workspace-intelligence/goal-pack.v1.json |