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
  • console: Launch a SQL console to query Spiral tables.
  • orgs: Org admin.
  • projects: Projects and grants.
  • fs: File Systems.
  • tables: Spiral Tables.
  • ks: Key Space Indexes.
  • text: Text Indexes.
  • telemetry: Client-side telemetry.
  • iceberg: Apache Iceberg Catalog.

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 console

Launch a SQL console to query Spiral tables.

Usage:

$ spiral console [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.
  • create: Create a new 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.

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]

Options:

  • --name TEXT: The human-readable name of the organization.
  • --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 projects

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List projects.
  • create: Create a new 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:

  • --id-prefix TEXT: An optional ID prefix to which a random number will be appended.
  • --name TEXT: Friendly name for the project.
  • --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 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.
  • --conditions TEXT: {key}={value} token conditions to apply to the grant
  • --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 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|gcs|upstream]: Type of the file system.
  • --provider TEXT: Provider, when using builtin type.
  • --endpoint TEXT: Endpoint, when using s3 type.
  • --region TEXT: Region, when using s3 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.
  • --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 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.
  • key-schema: Show the table key schema.
  • schema: Compute the full table schema.
  • wal: Fetch Write-Ahead-Log.
  • flush: Flush Write-Ahead-Log.
  • manifests: Display all manifests.
  • debug-scan: Visualize the scan of a given column group.
  • dump-scan: Display the manifests for a scan of a…

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]
  • --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 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 manifests

Display all manifests.

Usage:

$ spiral tables manifests [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

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 tables dump-scan

Display the manifests for a scan of a given column group.

Usage:

$ spiral tables dump-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 ks

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List indexes.
  • show: Show index partitions.
  • sync: Trigger a sync job for an index.
  • sync-local: Run a sync and wait for it to complete.

spiral ks ls

List indexes.

Usage:

$ spiral ks ls [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --help: Show this message and exit.

spiral ks show

Show index partitions.

Usage:

$ spiral ks show [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

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

spiral ks sync

Trigger a sync job for an index.

Usage:

$ spiral ks sync [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --name TEXT: Index name.
  • --resources [small|large]: Resources to use for the sync job. [default: small]
  • --help: Show this message and exit.

spiral ks sync-local

Run a sync and wait for it to complete.

Usage:

$ spiral ks sync-local [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

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

spiral text

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • ls: List indexes.
  • sync: Trigger a sync job for an index.
  • serve: Spin up a worker to serve an index.
  • workers: List search workers.
  • shutdown: Shutdown a search worker.

spiral text ls

List indexes.

Usage:

$ spiral text ls [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --help: Show this message and exit.

spiral text sync

Trigger a sync job for an index.

Usage:

$ spiral text sync [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --name TEXT: Index name.
  • --resources [small|large]: Resources to use for the sync job. [default: small]
  • --help: Show this message and exit.

spiral text serve

Spin up a worker to serve an index.

Usage:

$ spiral text serve [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --index TEXT: Index name.
  • --region [us-east4|europe-west4]: GCP region for the worker. [default: us-east4]
  • --cpu [1|2|4|8]: CPU resources for the worker. [default: 1]
  • --memory [512Mi|1Gi|2Gi|4Gi|8Gi]: Memory resources for the worker in MB. [default: 512Mi]
  • --help: Show this message and exit.

spiral text workers

List search workers.

Usage:

$ spiral text workers [OPTIONS] [PROJECT]

Arguments:

  • [PROJECT]: Project ID

Options:

  • --index TEXT: Index name.
  • --help: Show this message and exit.

spiral text shutdown

Shutdown a search worker.

Usage:

$ spiral text shutdown [OPTIONS] WORKER_ID

Arguments:

  • WORKER_ID: [required]

Options:

  • --help: Show this message and exit.

spiral telemetry

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • export: Issue new telemetry export token.

spiral telemetry export

Issue new telemetry export token.

Usage:

$ spiral telemetry export [OPTIONS]

Options:

  • --help: Show this message and exit.

spiral iceberg

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • namespaces: List namespaces.
  • tables: List tables.
  • schema: Show the table schema.

spiral iceberg namespaces

List namespaces.

Usage:

$ spiral iceberg namespaces [OPTIONS] [PROJECT] [NAMESPACE]

Arguments:

  • [PROJECT]: Project ID
  • [NAMESPACE]: List only namespaces under this namespace.

Options:

  • --help: Show this message and exit.

spiral iceberg tables

List tables.

Usage:

$ spiral iceberg tables [OPTIONS] [PROJECT] [NAMESPACE]

Arguments:

  • [PROJECT]: Project ID
  • [NAMESPACE]: Show only tables in the given namespace.

Options:

  • --help: Show this message and exit.

spiral iceberg schema

Show the table schema.

Usage:

$ spiral iceberg schema [OPTIONS] [PROJECT] NAMESPACE TABLE

Arguments:

  • [PROJECT]: Project ID
  • NAMESPACE: Table namespace. [required]
  • TABLE: Table name. [required]

Options:

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