CLI
Sign in, manage organizations, projects, and workload identities, and run workers from the terminal.
Use the spiral CLI to sign in and manage your application's resources from the terminal.
Install
Install from PyPI:
pip install 'spiral-cli[sql]'
spiral loginThe spiral-cli installation supplies sign-in, identity, Organization, Project, storage, Workload, Connection and documentation commands. SQL and local Connect require the separately installed spiral-sql package. spiral sql dispatches to spiral-sql, and spiral connect dispatches to spiral-connect. Install spiral-cli[sql] for both. Worker execution requires the spiral-host execution host; its reference page states this requirement. Configure table compaction in Studio.
Commands
| Command | Summary |
|---|---|
spiral login | Authenticate with SpiralDB |
spiral logout | Remove stored SpiralDB credentials from this machine |
spiral whoami | Show information about the currently authenticated principal |
spiral worker | Execute durable Spiral Tasks |
spiral docs | Print LLM-friendly documentation as Markdown |
spiral orgs | Manage organizations, members, and settings |
spiral projects | Create projects and manage access grants |
spiral fs | Configure Project storage and mounts |
spiral volumes | Register Volumes and manage storage credentials |
spiral workloads | Manage workload identities and how they sign in |
spiral connections | Manage Connections: named credentials for external systems |
spiral sql | Run DataFusion SQL and SPQL functions |
spiral connect | Serve ScanDAL on this machine for Spiral Studio on the web |
Found a problem? Edit this page or report an issue.