Skip to content

CLI Recipes

kadubon edited this page Jun 21, 2026 · 4 revisions

CLI Recipes

These examples use pic-ts, the recommended CLI name for the npm package.

Check Agent Output

npx pic-ts agent check --compact --text "Candidate packet: preserve residuals." --profile development
npx pic-ts agent intake --text "Candidate packet: preserve residuals." --profile development
npx pic-ts agent runbook --profile development

Plan The Next Workflow Step

npx pic-ts phase plan --compact --text "Candidate packet: preserve residuals." --profile development
npx pic-ts phase gap --compact --profile development
npx pic-ts phase runbook --profile development

Create A Demo Workspace

npx pic-ts demo bootstrap --output-dir .pic-demo --overwrite
npx pic-ts demo installed-smoke

Run A Runtime Step

npx pic-ts runtime step \
  --state .pic-demo/runtime_state.json \
  --input .pic-demo/runtime_step_input.json \
  --output .pic-demo/runtime_step_report.generated.json

Work With Packets

npx pic-ts packet export \
  --report .pic-demo/runtime_step_report.generated.json \
  --output .pic-demo/packet.json

npx pic-ts packet inspect --packet .pic-demo/packet.json

Packet commands treat files as data. They do not execute embedded command-like text.

Generate Markdown Reports

npx pic-ts adoption request --format markdown --language en --output adoption-request.md
npx pic-ts adoption request --format markdown --language ja --output adoption-request-ja.md
npx pic-ts phase dashboard --format markdown --output phase-dashboard.md

Markdown reports are for humans. JSON reports remain the machine-readable contract.

Inspect Schemas

npx pic-ts schema --type PhaseAccelerationPlan
npx pic-ts schema --type RuntimeStepReport
npx pic-ts schema --all --output-dir schemas

Verify Portability Fixtures

npx pic-ts portability verify --manifest fixtures/portability_conformance/manifest.json

When installed from npm, the package includes the fixture files needed for the built-in smoke and conformance paths.

Use The Compatibility Alias

npx pic agent check --compact --text "Candidate packet: preserve residuals." --profile development

Use pic-ts when both the Python and npm packages may be installed.

Clone this wiki locally