Skip to main content

CLI command reference

This reference describes the native APS 0.6 command surface audited from the released CLI definitions. Run aps <command> --help for the flags supported by your installed version.

Command index​

CommandPurposeChanges project files?
aps initCreate an APS project through the wizard, flags, or saved configurationYes
aps setupAdd optional hooks, agent support, or tool integrationsUsually
aps updateReconcile APS-managed templates and installed skillsYes
aps migratePreview or apply migration from an older vendored runtimeOnly with --apply
aps lintValidate APS documentsNo
aps nextSelect ready work whose dependencies are completeNo
aps startMark one ready item in progress and write its context packageYes
aps completeMark one in-progress item complete and optionally record a learningYes
aps graphPrint work items and dependency arrowsNo
aps rollupPrint a current monorepo roll-up tableNo
aps auditCompare plan state with project stateNo plan edits; may execute validation commands
aps exportEmit an aps-export/v1 JSON snapshotNo
aps doctorDiagnose the installed binary, project pin, and old runtime filesNo

Global options​

aps --version
aps --help
aps --strict lint

--strict turns a project CLI-version mismatch into a non-zero exit for project-scoped commands.

Initialisation and maintenance​

aps init
aps init --non-interactive --profile team --shape monorepo
aps setup codex
aps update
aps doctor
aps migrate --dry-run
aps migrate --apply

aps init --from <config.yml> replays a previous initialisation selection. Use aps init --help for selectable tools, templates, paths, components, hook verbosity, and model preferences.

Authoring​

aps lint
aps lint plans/modules/auth.aps.md
aps lint plans --json

An explicit lint target wins over project discovery. Without one, APS finds the nearest .aps/config.yml and reads its plans_dir.

Orchestration​

aps next
aps next auth
aps start AUTH-003
aps complete AUTH-003 --learning "A durable observation"
aps graph auth

next, start, complete, and graph accept --plans <dir>. Federated plans also accept --child <name>; start and complete accept a qualified ID such as catalog:PROD-001.

Monorepo views​

aps next --package core
aps next --by-package
aps rollup --by-package
aps rollup --plans packages

Package filters use a work item's Packages field, falling back to its module metadata. Federated roll-up reads child plans linked from the root.

Audit​

aps audit --no-run
aps audit auth --json --no-run
aps audit --stale-days 30 --no-run

Omitting --no-run executes validation commands stored in completed work items. Only do that for trusted plan content.

Export​

aps export --json
aps export --plans packages

JSON is the only export format; --json is accepted to make the intent explicit.

Plan-root resolution​

For commands that operate on a plan tree, the order is:

  1. an explicit target or --plans value;
  2. the APS_PLANS environment variable;
  3. plans_dir from the nearest .aps/config.yml; then
  4. plans/.

See run the APS workflow for the end-to-end sequence.