Command reference
Every user-facing cargoship command, grouped by task. The flag tables on these pages are generated directly from the CLI, so they always match the version you have installed.
Generated reference
The synopsis, examples, and flag list for each command are produced by cargoship mddocs from the live command tree and vendored into the docs. A CI drift check fails if they fall out of sync, so what you read here is what the binary actually accepts.
By task
| Page | Commands |
|---|---|
| Uploading & sync | upload, create upload, sync, migrate, resume |
| Inspection & retrieval | list, info, verify, balance, download, restore, browse, shell |
| Cost, budget & alerts | estimate, analyze, cost …, budget …, alerts …, lifecycle |
| DVC | dvc stages, dvc status, dvc export |
| Configuration & context | config, setup, context … |
| Destructive operations | delete, scuttle |
| Diagnostics & utilities | benchmark, dashboard, profile …, create keys, metrics |
| Global flags | flags available on every command |
Other references
- Environment variables
- Configuration schema
- CargoShip vs. other tools
- Recovery & operations runbook
- Troubleshooting · FAQ
- Glossary · Cheat sheet
Looking for the on-disk format instead of commands? See the Archive & Manifest Format Spec.