Skip to Content
Command Line

spiral

Usage:

$ spiral [OPTIONS] COMMAND [ARGS]...

Options:

  • --version: Display the version of the Spiral CLI.
  • -v, --verbose: Increase log verbosity. Use -v for info, -vv for debug. [default: 0]
  • --json: Emit output as JSON instead of formatted tables.
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • login: Authenticate with Spiral.
  • whoami: Show information about the currently…
  • walkthrough: Take a guided tour of Spiral.
  • orgs: Manage organizations, members and settings.
  • projects: Create projects and manage access grants.
  • tables: Create, inspect and manage tables.
  • fs: Configure project storage and mounts.
  • video: Inspect and transcode H.264 video.
  • txn: Inspect and revert table transactions.
  • workloads: Manage workloads and OIDC access policies.
  • config: Inspect the CLI’s effective configuration.

spiral login

Authenticate with Spiral.

Usage:

$ spiral login [OPTIONS]

Options:

  • --org, --org-id TEXT: Organization to log in to.
  • --force: Force re-authentication even if already logged in.
  • --show-token: Print the access token (useful for scripting).
  • --help: Show this message and exit.

spiral whoami

Show information about the currently authenticated principal.

Usage:

$ spiral whoami [OPTIONS]

Options:

  • --json: Emit output as JSON.
  • --help: Show this message and exit.

spiral walkthrough

Take a guided tour of Spiral.

Creates a project, ingests the Suno example dataset from HuggingFace, and then walks through the core table commands — schema, head, fragments, stats, transaction history and the project’s file system — printing the equivalent CLI command for each step so you can reproduce it yourself.

Ingestion needs network access and the datasets package (pip install datasets). By default this creates a throwaway project and offers to delete it at the end. Pass —project to use one of your own, —keep to retain the demo data, or —yes to run unattended.

Usage:

$ spiral walkthrough [OPTIONS]

Options:

  • -p, --project TEXT: Use an existing project instead of creating a throwaway one.
  • -y, --yes: Run every step without pausing, and clean up automatically when done.
  • --keep: Keep the demo project and its data after the walkthrough finishes.
  • --help: Show this message and exit.

spiral orgs

Usage:

$ spiral orgs [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • switch: Switch the active organization.
  • create: Create a new organization.
  • ls: List the organizations you belong to,…
  • invite: Invite a user to the organization.
  • sso: Configure single sign-on for your…
  • directory: Configure directory services for your…
  • audit-logs: Configure audit logs for your organization.
  • log-streams: Configure log streams for your organization.
  • domains: Configure domains for your organization.
  • keys: Configure bring-your-own-key for your…
  • users: List and manage organization members.

spiral orgs switch

Switch the active organization.

Usage:

$ spiral orgs switch [OPTIONS] [ORG_ID]

Arguments:

  • [ORG_ID]: Organization ID.

Options:

  • --help: Show this message and exit.

spiral orgs create

Create a new organization.

Usage:

$ spiral orgs create [OPTIONS] [NAME]

Arguments:

  • [NAME]: Organization name.

Options:

  • --help: Show this message and exit.

spiral orgs ls

List the organizations you belong to, marking the active one.

Usage:

$ spiral orgs ls [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral orgs invite

Invite a user to the organization.

Usage:

$ spiral orgs invite [OPTIONS] EMAIL

Arguments:

  • EMAIL: Email address to invite. [required]

Options:

  • --role [owner|member|guest]: Role to grant the invited user. [default: member]
  • --expires-in-days INTEGER: Days until the invitation expires. [default: 7]
  • --help: Show this message and exit.

spiral orgs sso

Configure single sign-on for your organization.

Usage:

$ spiral orgs sso [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral orgs directory

Configure directory services for your organization.

Usage:

$ spiral orgs directory [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral orgs audit-logs

Configure audit logs for your organization.

Usage:

$ spiral orgs audit-logs [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral orgs log-streams

Configure log streams for your organization.

Usage:

$ spiral orgs log-streams [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral orgs domains

Configure domains for your organization.

Usage:

$ spiral orgs domains [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral orgs keys

Configure bring-your-own-key for your organization.

Usage:

$ spiral orgs keys [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral orgs users

Usage:

$ spiral orgs users [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List users in the active organization.

spiral orgs users ls

List users in the active organization.

Usage:

$ spiral orgs users ls [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral projects

Usage:

$ spiral projects [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List the projects in your active…
  • create: Create a new project in your active…
  • drop: Drop a project.
  • grant: Grant a role on a project to a user, org…
  • grants: List the active access grants on a project.
  • grant-info: Show details for a single grant.
  • revoke: Revoke a grant by ID.

spiral projects ls

List the projects in your active organization.

Usage:

$ spiral projects ls [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral projects create

Create a new project in your active organization.

Usage:

$ spiral projects create [OPTIONS]

Options:

  • -d, --description TEXT: Human-readable description for the project.
  • --id-prefix TEXT: An optional ID prefix to which a random number will be appended.
  • --help: Show this message and exit.

spiral projects drop

Drop a project. Prompts for confirmation unless —yes is given.

Usage:

$ spiral projects drop [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID.

Options:

  • -y, --yes: Skip the confirmation prompt.
  • --help: Show this message and exit.

spiral projects grant

Grant a role on a project to a user, org role, or workload.

Usage:

$ spiral projects grant [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID.

Options:

  • --role [viewer|editor|admin]: Project role to grant. [required]
  • --org-id TEXT: Organization ID, to grant a role to organization user(s).
  • --org-user TEXT: User ID (use with —org-id) to grant a role to a user.
  • --org-role [owner|member|guest]: Org role (use with —org-id) to grant a role to all users with that role.
  • --workload-id TEXT: Workload ID, to grant a role to a workload.
  • --help: Show this message and exit.

spiral projects grants

List the active access grants on a project.

Usage:

$ spiral projects grants [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID.

Options:

  • --help: Show this message and exit.

spiral projects grant-info

Show details for a single grant.

Usage:

$ spiral projects grant-info [OPTIONS] GRANT_ID

Arguments:

  • GRANT_ID: Grant ID. [required]

Options:

  • --help: Show this message and exit.

spiral projects revoke

Revoke a grant by ID.

Usage:

$ spiral projects revoke [OPTIONS] GRANT_ID

Arguments:

  • GRANT_ID: Grant ID. [required]

Options:

  • -y, --yes: Skip the confirmation prompt.
  • --help: Show this message and exit.

spiral tables

Usage:

$ spiral tables [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List the tables in a project, grouped by…
  • head: Print the first N rows of a table…
  • move: Move a table into a different dataset.
  • rename: Rename a table within its dataset.
  • drop: Drop a table.
  • key-schema: Show a table’s key (primary key) schema.
  • schema: Compute and print a table’s full Arrow…
  • wal: Print a table’s write-ahead log…
  • flush: Flush a table’s write-ahead log,…
  • truncate: Truncate a table’s column-group metadata.
  • manifests: Deprecated alias for fragments. (DEPRECATED: Use ‘fragments’ instead.)
  • fragments: List the table’s fragments (data files)…
  • fragments-scan: Show the fragments that a scan of a given…
  • debug-scan: Render a detailed visualization of how a…
  • stats: Show row counts, fragment sizes and…
  • fs-mount: Mount an additional file system so a…
  • fs-show: List the file systems mounted on a table.

spiral tables ls

List the tables in a project, grouped by dataset.

Usage:

$ spiral tables ls [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID.

Options:

  • --help: Show this message and exit.

spiral tables head

Print the first N rows of a table (requires the polars extra).

Usage:

$ spiral tables head [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • -n INTEGER: Maximum number of rows to show. Defaults to 10. [default: 10]
  • --asof TEXT: Transaction timestamp from spiral txn ls (microseconds or UTC datetime).
  • --help: Show this message and exit.

spiral tables move

Move a table into a different dataset.

Usage:

$ spiral tables move [OPTIONS] [PROJECT] [TABLE] [NEW_DATASET]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).
  • [NEW_DATASET]: New dataset name.

Options:

  • --dataset TEXT: Dataset name.
  • --help: Show this message and exit.

spiral tables rename

Rename a table within its dataset.

Usage:

$ spiral tables rename [OPTIONS] [PROJECT] [TABLE] [NEW_TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).
  • [NEW_TABLE]: New table name.

Options:

  • --dataset TEXT: Dataset name.
  • --help: Show this message and exit.

spiral tables drop

Drop a table. Prompts for confirmation unless —yes is given.

Usage:

$ spiral tables drop [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • -y, --yes: Skip the confirmation prompt.
  • --help: Show this message and exit.

spiral tables key-schema

Show a table’s key (primary key) schema.

Usage:

$ spiral tables key-schema [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • --help: Show this message and exit.

spiral tables schema

Compute and print a table’s full Arrow schema, including all column groups.

Usage:

$ spiral tables schema [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • --help: Show this message and exit.

spiral tables wal

Print a table’s write-ahead log (uncommitted/unflushed writes).

Usage:

$ spiral tables wal [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • --help: Show this message and exit.

spiral tables flush

Flush a table’s write-ahead log, compacting recent writes into metadata.

Usage:

$ spiral tables flush [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • --help: Show this message and exit.

spiral tables truncate

Truncate a table’s column-group metadata. Destructive: breaks as-of queries.

Usage:

$ spiral tables truncate [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • -y, --yes: Skip the confirmation prompt.
  • --help: Show this message and exit.

spiral tables manifests

Deprecated alias for fragments.

Usage:

$ spiral tables manifests [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • --max-rows INTEGER: Maximum number of rows to show per manifest.
  • --asof TEXT: Transaction timestamp from spiral txn ls (microseconds or UTC datetime).
  • --help: Show this message and exit.

spiral tables fragments

List the table’s fragments (data files) per column group, from metadata.

Usage:

$ spiral tables fragments [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • --max-rows INTEGER: Maximum number of fragments to show per manifest.
  • --asof TEXT: Transaction timestamp from spiral txn ls (microseconds or UTC datetime).
  • --help: Show this message and exit.

spiral tables fragments-scan

Show the fragments that a scan of a given column group would read.

Usage:

$ spiral tables fragments-scan [OPTIONS] [PROJECT] [TABLE] [COLUMN_GROUP]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).
  • [COLUMN_GROUP]: Dot-separated column group path. [default: .]

Options:

  • --dataset TEXT: Dataset name.
  • --help: Show this message and exit.

spiral tables debug-scan

Render a detailed visualization of how a column group is scanned.

Usage:

$ spiral tables debug-scan [OPTIONS] [PROJECT] [TABLE] [COLUMN_GROUP]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).
  • [COLUMN_GROUP]: Dot-separated column group path. [default: .]

Options:

  • --dataset TEXT: Dataset name.
  • --help: Show this message and exit.

spiral tables stats

Show row counts, fragment sizes and compaction indicators for a table.

Usage:

$ spiral tables stats [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • --help: Show this message and exit.

spiral tables fs-mount

Mount an additional file system so a table’s scans can read from it.

Usage:

$ spiral tables fs-mount [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • --file-system-project TEXT: Project for which a bucket is configured; that bucket is being mounted.
  • --directory TEXT: Directory path within the file system project.
  • --help: Show this message and exit.

spiral tables fs-show

List the file systems mounted on a table.

Usage:

$ spiral tables fs-show [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • --help: Show this message and exit.

spiral fs

Usage:

$ spiral fs [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • show: Show the file system configured for a…
  • update: Update a project’s default file system.
  • list-providers: List the built-in (Spiral-managed) file…
  • mounts: Grant resources access to file-system directories.

spiral fs show

Show the file system configured for a project.

Usage:

$ spiral fs show [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID.

Options:

  • --help: Show this message and exit.

spiral fs update

Update a project’s default file system.

Usage:

$ spiral fs update [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID.

Options:

  • --type [builtin|s3|s3like|gcs|upstream]: Type of the file system.
  • --provider TEXT: Provider, when using builtin type.
  • --endpoint TEXT: Endpoint, when using s3 or s3like type.
  • --region TEXT: Region, for s3/s3like/gcs (defaults to auto for s3 when endpoint is set).
  • --bucket TEXT: Bucket, when using s3 or gcs type.
  • --directory TEXT: Directory path within the file system, for s3/s3like/gcs.
  • --role-arn TEXT: Role ARN to assume, when using s3 type.
  • -y, --yes: Skip confirmation prompts.
  • --dangerously-move-data: Allow updating a file system which has mounted tables.
  • --help: Show this message and exit.

spiral fs list-providers

List the built-in (Spiral-managed) file system providers you can choose from.

Usage:

$ spiral fs list-providers [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral fs mounts

Usage:

$ spiral fs mounts [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List mounts in a project’s file system.
  • info: Show details for a single mount.
  • create: Create a mount granting a principal access…
  • rm: Remove a mount by ID.

spiral fs mounts ls

List mounts in a project’s file system.

Usage:

$ spiral fs mounts ls [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID.

Options:

  • --help: Show this message and exit.

spiral fs mounts info

Show details for a single mount.

Usage:

$ spiral fs mounts info [OPTIONS] MOUNT_ID

Arguments:

  • MOUNT_ID: Mount ID. [required]

Options:

  • --help: Show this message and exit.

spiral fs mounts create

Create a mount granting a principal access to a directory.

Usage:

$ spiral fs mounts create [OPTIONS] [PROJECT] DIRECTORY PRINCIPAL

Arguments:

  • [PROJECT]: Project ID.
  • DIRECTORY: Directory path within the file system (e.g. /data/). [required]
  • PRINCIPAL: Principal to grant access to. [required]

Options:

  • --mode [ro|rw]: Access mode. [default: ro]
  • --help: Show this message and exit.

spiral fs mounts rm

Remove a mount by ID.

Usage:

$ spiral fs mounts rm [OPTIONS] MOUNT_ID

Arguments:

  • MOUNT_ID: Mount ID. [required]

Options:

  • -y, --yes: Skip the confirmation prompt.
  • --help: Show this message and exit.

spiral video

Usage:

$ spiral video [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • inspect
  • transcode
  • transcode-annex-b

spiral video inspect

Usage:

$ spiral video inspect [OPTIONS] PATH

Arguments:

  • PATH: Input H.264 MP4 file. [required]

Options:

  • --show-frames INTEGER: Frames to print per GOP. [default: 24]
  • --max-gops INTEGER: Maximum GOPs to print. [default: 8]
  • --json: Print the full video index as JSON.
  • --help: Show this message and exit.

spiral video transcode

Usage:

$ spiral video transcode [OPTIONS] SOURCE

Arguments:

  • SOURCE: Input source video. [required]

Options:

  • -o, --output PATH: Output prefix-packed MP4 path.
  • --encoder PATH: Optional H.264 encoder command. Defaults to PATH/env configuration.
  • --fps TEXT: Comma-separated exact FPS ladder to preserve. [default: 10]
  • --quality TEXT: Single CRF or comma-separated QPs aligned with —fps. [default: 25]
  • --multi-track: Add each retained FPS rate as a separate MP4 track.
  • --size TEXT: Resize output video to WIDTHxHEIGHT before encoding.
  • --preset TEXT: Encoder preset. [default: medium]
  • --ffmpeg-arg TEXT: Additional raw ffmpeg argument. Repeat for each token.
  • --x264-param TEXT: Additional raw x264 parameter. Repeat for each name=value token.
  • --help: Show this message and exit.

spiral video transcode-annex-b

Usage:

$ spiral video transcode-annex-b [OPTIONS] SOURCE

Arguments:

  • SOURCE: Input source video. [required]

Options:

  • --config PATH: spiral-h264 JSON config. [required]
  • --annex-b PATH: Output Annex B H.264 path. [required]
  • --metadata PATH: Output JSONL sample metadata path. [required]
  • --ffmpeg TEXT: ffmpeg executable. [default: ffmpeg]
  • --spiral-h264 TEXT: spiral-h264 executable. Defaults to SPIRAL_H264/SPIRAL_H264_BIN or PATH.
  • --fps TEXT: Optional ffmpeg output rate.
  • --video-filter TEXT: Optional ffmpeg -vf filter.
  • --filter-complex TEXT: Optional ffmpeg -filter_complex graph.
  • --map-video TEXT: Optional ffmpeg -map output.
  • --frames-v INTEGER: Optional ffmpeg frame limit.
  • --help: Show this message and exit.

spiral txn

Usage:

$ spiral txn [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List the transaction history of a table,…
  • revert: Revert a transaction by table ID and…

spiral txn ls

List the transaction history of a table, newest operations included.

Usage:

$ spiral txn ls [OPTIONS] [PROJECT] [TABLE]

Arguments:

  • [PROJECT]: Project ID.
  • [TABLE]: Table name (optionally dataset.table).

Options:

  • --dataset TEXT: Dataset name.
  • --since INTEGER: Only list transactions committed after this timestamp (microseconds).
  • --help: Show this message and exit.

spiral txn revert

Revert a transaction by table ID and transaction index.

Usage:

$ spiral txn revert [OPTIONS] TABLE_ID TXN_IDX

Arguments:

  • TABLE_ID: Table ID. [required]
  • TXN_IDX: Transaction index to revert. [required]

Options:

  • -y, --yes: Skip the confirmation prompt.
  • --help: Show this message and exit.

spiral workloads

Usage:

$ spiral workloads [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List the workloads (machine identities) in…
  • create: Create a new workload (machine identity)…
  • deactivate: Deactivate a workload.
  • issue-creds: Issue new client credentials (client id +…
  • revoke-creds: Revoke a workload’s client credentials by…
  • policies: List the OIDC trust policies attached to a…
  • delete-policy: Delete a workload OIDC trust policy by id.
  • create-policy: Create a workload policy.

spiral workloads ls

List the workloads (machine identities) in a project.

Usage:

$ spiral workloads ls [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID.

Options:

  • --help: Show this message and exit.

spiral workloads create

Create a new workload (machine identity) in a project.

Usage:

$ spiral workloads create [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID.

Options:

  • --name TEXT: Friendly name for the workload.
  • --help: Show this message and exit.

spiral workloads deactivate

Deactivate a workload. Removes all associated credentials and policies.

Usage:

$ spiral workloads deactivate [OPTIONS] WORKLOAD_ID

Arguments:

  • WORKLOAD_ID: Workload ID. [required]

Options:

  • -y, --yes: Skip the confirmation prompt.
  • --help: Show this message and exit.

spiral workloads issue-creds

Issue new client credentials (client id + secret) for a workload.

Usage:

$ spiral workloads issue-creds [OPTIONS] WORKLOAD_ID

Arguments:

  • WORKLOAD_ID: Workload ID. [required]

Options:

  • -y, --yes: Skip prompt and print secret to console.
  • --help: Show this message and exit.

spiral workloads revoke-creds

Revoke a workload’s client credentials by client id.

Usage:

$ spiral workloads revoke-creds [OPTIONS] CLIENT_ID

Arguments:

  • CLIENT_ID: Client ID to revoke. [required]

Options:

  • --help: Show this message and exit.

spiral workloads policies

List the OIDC trust policies attached to a workload.

Usage:

$ spiral workloads policies [OPTIONS] [WORKLOAD_ID]

Arguments:

  • [WORKLOAD_ID]: Workload ID.

Options:

  • --help: Show this message and exit.

spiral workloads delete-policy

Delete a workload OIDC trust policy by id.

Usage:

$ spiral workloads delete-policy [OPTIONS] POLICY_ID

Arguments:

  • POLICY_ID: Policy ID. [required]

Options:

  • -y, --yes: Skip the confirmation prompt.
  • --help: Show this message and exit.

spiral workloads create-policy

Create a workload policy.

The audience (aud) claim of OIDC tokens must be https://iss.spiraldb.com  (except for Modal, where the audience is oidc.modal.com). See https://docs.spiraldb.com/oidc  for more info.

Usage:

$ spiral workloads create-policy [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • github: Create a policy for a GitHub Actions…
  • modal: Create a policy for a Modal environment.
  • gcp: Create a policy for a GCP environment.
  • aws: Create a policy for an AWS environment.
  • oidc: Create a policy with a custom OIDC issuer.

spiral workloads create-policy github

Create a policy for a GitHub Actions environment.

Usage:

$ spiral workloads create-policy github [OPTIONS] WORKLOAD_ID

Arguments:

  • WORKLOAD_ID: Workload ID. [required]

Options:

  • --repository TEXT: GitHub repository (org/repo). [required]
  • --environment TEXT: GitHub deployment environment name.
  • --ref TEXT: Git ref (e.g. refs/heads/main).
  • --sha TEXT: Commit SHA that triggered the workflow.
  • --repository-owner TEXT: Repository owner (org or user).
  • --actor-id TEXT: GitHub user ID of the actor.
  • --repository-visibility TEXT: Repository visibility (public, private, internal).
  • --repository-id TEXT: Repository ID.
  • --repository-owner-id TEXT: Repository owner ID.
  • --runner-environment TEXT: Runner environment (github-hosted or self-hosted).
  • --actor TEXT: GitHub username of the actor.
  • --workflow TEXT: Workflow name.
  • --head-ref TEXT: Head ref (source branch for PRs).
  • --base-ref TEXT: Base ref (target branch for PRs).
  • --event-name TEXT: Event that triggered the workflow (e.g. push, pull_request).
  • --ref-type TEXT: Ref type (branch or tag).
  • --job-workflow-ref TEXT: Reusable workflow ref.
  • --help: Show this message and exit.

spiral workloads create-policy modal

Create a policy for a Modal environment.

Usage:

$ spiral workloads create-policy modal [OPTIONS] WORKLOAD_ID

Arguments:

  • WORKLOAD_ID: Workload ID. [required]

Options:

  • --workspace-id TEXT: Modal workspace ID. [required]
  • --environment-name TEXT: Modal environment name.
  • --environment-id TEXT: Modal environment ID.
  • --app-id TEXT: Modal app ID.
  • --app-name TEXT: Modal app name.
  • --function-id TEXT: Modal function ID.
  • --function-name TEXT: Modal function name.
  • --container-id TEXT: Modal container ID.
  • --help: Show this message and exit.

spiral workloads create-policy gcp

Create a policy for a GCP environment.

Usage:

$ spiral workloads create-policy gcp [OPTIONS] WORKLOAD_ID

Arguments:

  • WORKLOAD_ID: Workload ID. [required]

Options:

  • --email TEXT: GCP service account email. [required]
  • --unique-id TEXT: GCP unique ID (sub claim). [required]
  • --help: Show this message and exit.

spiral workloads create-policy aws

Create a policy for an AWS environment.

Usage:

$ spiral workloads create-policy aws [OPTIONS] WORKLOAD_ID

Arguments:

  • WORKLOAD_ID: Workload ID. [required]

Options:

  • --account TEXT: AWS account ID. [required]
  • --role TEXT: AWS IAM role name. [required]
  • --help: Show this message and exit.

spiral workloads create-policy oidc

Create a policy with a custom OIDC issuer.

Usage:

$ spiral workloads create-policy oidc [OPTIONS] WORKLOAD_ID

Arguments:

  • WORKLOAD_ID: Workload ID. [required]

Options:

  • --iss TEXT: OIDC issuer URL. [required]
  • --conditions TEXT: Conditions in KEY=VALUE format. Can be provided multiple times.
  • --help: Show this message and exit.

spiral config

Usage:

$ spiral config [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • show: Show the resolved Spiral configuration and…

spiral config show

Show the resolved Spiral configuration and the files it was loaded from.

Usage:

$ spiral config show [OPTIONS]

Options:

  • --help: Show this message and exit.
Last updated on
spiral.vizClient Configuration