Reference
Use these pages to look up configuration fields, package references, file paths, and
script interfaces. For command syntax, see Commands or run
sow help COMMAND.
Fields, defaults, validation rules, signing references, and publication targets in sow.yml.
Select packages by digest, coordinate, filename, or name. Resolve ambiguous matches.
Locate package files, indexes, private state, and publication output.
Interpret command results and choose the next action in scripts.
Read the sow.cli/v1 response and command result fields.
Check supported systems, filesystems, client formats, and integration coverage.
Find the next step for configuration, build, signing, and publication errors.
Example conventions
Command blocks omit the shell prompt so you can copy them. Uppercase words such as NAME
and DIR in syntax descriptions are placeholders. Square brackets mean optional arguments;
... means repeatable arguments; | separates alternatives.
Output paths, IDs, hashes, timestamps, and counts depend on the workspace. Keep operation and generation IDs as strings; see JSON output.
Troubleshooting
Find the next command for migration, pending builds, interrupted publication, locks, and integrity errors.
sow.yml Reference
Workspace fields, defaults, validation rules, signing references, and publication targets.
Package References
Select packages by digest, coordinate, filename, or name, and resolve ambiguous matches.
Repository Layout
Locate package files, repository indexes, private state, and publication output.
Exit Codes
Exit codes 0–6 and interruption code 130, with meanings and examples.
JSON Output
Look up JSON response fields, package and operation IDs, errors, and command results.
Platforms & Integrations
Supported platforms, filesystem requirements, repository formats, clients, and integration coverage.