Skip to Content
Command Line

spiral

Usage:

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

Options:

  • --version: Display the version of the Spiral CLI.
  • --verbose: Use more verbose output.
  • --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
  • whoami: Display the current user’s information.
  • orgs: Org admin.
  • projects: Projects and grants.
  • tables: Spiral Tables.
  • fs: File Systems.
  • txn: Table Transactions.
  • workloads

spiral login

Usage:

$ spiral login [OPTIONS]

Options:

  • --org-id TEXT
  • --force / --no-force: [default: no-force]
  • --show-token / --no-show-token: [default: no-show-token]
  • --help: Show this message and exit.

spiral whoami

Display the current user’s information.

Usage:

$ spiral whoami [OPTIONS]

Options:

  • --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.
  • ls: List organizations.
  • 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…

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 ls

List organizations.

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: [required]

Options:

  • --role [owner|member|guest]: [default: member]
  • --expires-in-days INTEGER: [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 projects

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List projects.
  • create: Create a new project.
  • drop: Drop a project.
  • grant: Grant a role on a project to a principal.
  • grants: List project grants.

spiral projects ls

List projects.

Usage:

$ spiral projects ls [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral projects create

Create a new project.

Usage:

$ spiral projects create [OPTIONS]

Options:

  • --description TEXT: Description for the project. [required]
  • --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.

Usage:

$ spiral projects drop [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --help: Show this message and exit.

spiral projects grant

Grant a role on a project to a principal.

Usage:

$ spiral projects grant [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --role [viewer|editor|admin]: Project role to grant. [required]
  • --org-id TEXT: Pass an organization ID to grant a role to an organization user(s).
  • --org-user TEXT: Pass a user ID when using —org-id to grant a role to a user.
  • --org-role [owner|member|guest]: Pass an org role when using —org-id to grant a role to all users with that role.
  • --workload-id TEXT: Pass a workload ID to grant a role to a workload.
  • --github TEXT: Pass an {org}/{repo} string to grant a role to a job running in GitHub Actions.
  • --modal TEXT: Pass a {workspace_id}/{env_name} string to grant a role to a job running in Modal environment.
  • --gcp-service-account TEXT: Pass a {service_account_email}/{unique_id} to grant a role to a GCP service account.
  • --aws-iam-role TEXT: Pass a {account_id}/{role_name} to grant a Spiral role to an AWS IAM Role.
  • --help: Show this message and exit.

spiral projects grants

List project grants.

Usage:

$ spiral projects grants [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --help: Show this message and exit.

spiral tables

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List tables.
  • head: Show the leading rows of the table.
  • move: Move table to a different dataset.
  • rename: Rename table.
  • drop: Drop table.
  • key-schema: Show the table key schema.
  • schema: Compute the full table schema.
  • wal: Fetch Write-Ahead-Log.
  • flush: Flush Write-Ahead-Log.
  • truncate: Truncate column group metadata.
  • manifests: Display all fragments from metadata. (DEPRECATED: Use ‘fragments’ instead.)
  • fragments: Display all fragments from metadata.
  • fragments-scan: Display the fragments used in a scan of a…
  • debug-scan: Visualize the scan of a given column group.

spiral tables ls

List tables.

Usage:

$ spiral tables ls [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --help: Show this message and exit.

spiral tables head

Show the leading rows of the table.

Usage:

$ spiral tables head [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --table TEXT: Table name.
  • --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 table to a different dataset.

Usage:

$ spiral tables move [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --table TEXT: Table name.
  • --dataset TEXT: Dataset name.
  • --new-dataset TEXT: New dataset name.
  • --help: Show this message and exit.

spiral tables rename

Rename table.

Usage:

$ spiral tables rename [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --table TEXT: Table name.
  • --dataset TEXT: Dataset name.
  • --new-table TEXT: New table name.
  • --help: Show this message and exit.

spiral tables drop

Drop table.

Usage:

$ spiral tables drop [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

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

spiral tables key-schema

Show the table key schema.

Usage:

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

Arguments:

  • [PROJECT]: Project ID

Options:

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

spiral tables schema

Compute the full table schema.

Usage:

$ spiral tables schema [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

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

spiral tables wal

Fetch Write-Ahead-Log.

Usage:

$ spiral tables wal [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

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

spiral tables flush

Flush Write-Ahead-Log.

Usage:

$ spiral tables flush [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

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

spiral tables truncate

Truncate column group metadata.

Usage:

$ spiral tables truncate [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

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

spiral tables manifests

Display all fragments from metadata.

Usage:

$ spiral tables manifests [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --table TEXT: Table name.
  • --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

Display all fragments from metadata.

Usage:

$ spiral tables fragments [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --table TEXT: Table name.
  • --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

Display the fragments used in a scan of a given column group.

Usage:

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

Arguments:

  • [PROJECT]: Project ID
  • [COLUMN_GROUP]: Dot-separated column group path. [default: .]

Options:

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

spiral tables debug-scan

Visualize the scan of a given column group.

Usage:

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

Arguments:

  • [PROJECT]: Project ID
  • [COLUMN_GROUP]: Dot-separated column group path. [default: .]

Options:

  • --table TEXT: Table name.
  • --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 project.
  • update: Update a project’s default file system.
  • list-providers: Lists the available built-in file system…

spiral fs show

Show the file system configured for 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, when using s3, s3like or gcs type (defaults to auto for s3 when endpoint is set).
  • --bucket TEXT: Bucket, when using s3 or gcs type.
  • --role-arn TEXT: Role ARN to assume, when using s3 type.
  • -y, --yes: Skip confirmation prompt.
  • --help: Show this message and exit.

spiral fs list-providers

Lists the available built-in file system providers.

Usage:

$ spiral fs list-providers [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral txn

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List transactions for a table.
  • revert: Revert a transaction by table ID and…

spiral txn ls

List transactions for a table.

Usage:

$ spiral txn ls [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --table TEXT: Table name.
  • --dataset TEXT: Dataset name.
  • --since INTEGER: 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: [required]
  • TXN_IDX: [required]

Options:

  • --help: Show this message and exit.

spiral workloads

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List workloads.
  • create: Create a new workload.
  • deactivate: Deactivate a workload.
  • issue-creds: Issue new workflow credentials.
  • revoke-creds: Revoke workflow credentials.
  • policies: List workload policies.
  • delete-policy: Delete a workload policy.
  • create-policy: Create a workload policy.

spiral workloads ls

List workloads.

Usage:

$ spiral workloads ls [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --help: Show this message and exit.

spiral workloads create

Create a new workload.

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:

  • --help: Show this message and exit.

spiral workloads issue-creds

Issue new workflow credentials.

Usage:

$ spiral workloads issue-creds [OPTIONS] WORKLOAD_ID

Arguments:

  • WORKLOAD_ID: Workload ID. [required]

Options:

  • --skip-prompt / --no-skip-prompt: Skip prompt and print secret to console. [default: no-skip-prompt]
  • --help: Show this message and exit.

spiral workloads revoke-creds

Revoke workflow credentials.

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 workload policies.

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 policy.

Usage:

$ spiral workloads delete-policy [OPTIONS] POLICY_ID

Arguments:

  • POLICY_ID: Policy ID. [required]

Options:

  • --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.
Last updated on
spiral.expressions.vectorClient Configuration