Apistry CLI Reference
This is the authoritative reference for the apistry command-line interface.
Execution Modes
| Mode | Description |
|---|---|
| Development | Local execution via serve |
| Configured | Licensed execution via start |
Global Options
--help--version--logLevel--env
Commands
serve
Starts Apistry in development mode.
Guarantees:
- No external dependencies
- NeDB by default
- Swagger UI at /docs
start (Licensed)
Starts Apistry with explicit configuration.
Guarantees: - Reproducible startup - Licensed features enabled
import
Imports data into collections.
Guarantees: - Atomic per-file import
export
Exports collections to files.
Guarantees: - Streaming output
etl run
Runs an ETL pipeline.
Guarantees: - Stage isolation - Dry-run validation
Error Behavior
- Configuration errors are fatal
- Validation errors are explicit
- Runtime errors are surfaced
Summary
The CLI is a control surface, not a workflow engine.