CLI Reference
The spade command-line tool is used throughout the block development and pipeline execution workflow. Below is a summary of all available commands.
| Command | Description |
|---|---|
spade run | Run a pipeline locally |
spade submit | Run a pipeline in the cloud, converting local file references on the way |
spade check | Validate blocks or pipelines |
spade install | Install a block collection from the cloud registry, a Git repository, or a local directory |
spade publish | Submit a block collection to the cloud registry for screening, build, and distribution |
spade init | Scaffold a new block collection |
spade add | Add a new block to the current collection |
spade setup | Initialize the local Spade environment |
spade login | Authenticate to the cloud registry |
spade secret | Manage local and cloud secrets for pipeline runs |
spade data | Upload, list, and download user data files referenced by pipelines |
spade clean | Remove local run directories, caches, and downloaded assets |
spade setup
Initialize the local Spade environment.
Read →spade init
Scaffold a new block collection.
Read →spade add
Add a new block to the current collection.
Read →spade check
Validate block collections or pipeline files.
Read →spade install
Install a block collection from the cloud registry, a Git repository, or a local directory.
Read →spade run
Execute a pipeline locally.
Read →spade submit
Run a locally-authored pipeline in the cloud, converting its local file references on the way.
Read →spade publish
Submit a block collection to the cloud registry for screening, build, signing, and distribution.
Read →spade login
Authenticate to a Spade server using the OAuth 2.0 device authorization flow.
Read →spade secret
Manage local and cloud secrets for pipeline runs.
Read →spade data
Upload, list, and download user data files referenced by pipelines.
Read →spade clean
Remove local run directories, caches, and downloaded assets.
Read →