spiral projects
Create projects and manage access grants
Usage: spiral projects [OPTIONS] <COMMAND>Options
| Option | Required | Default | Description |
|---|---|---|---|
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
Subcommands
| Command | Summary |
|---|---|
spiral projects ls | List the projects in your active organization |
spiral projects create | Create a new project in your active organization |
spiral projects drop | Drop a project |
spiral projects grant | Grant a role on a project to a user, org role, or workload |
spiral projects grants | List the active access grants on a project |
spiral projects grant-info | Show details for a single grant |
spiral projects revoke | Revoke a grant by ID |
spiral projects storage | Read or select the storage used for new tables |
spiral projects ls
Usage: spiral projects ls [OPTIONS]Options
| Option | Required | Default | Description |
|---|---|---|---|
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
spiral projects create
Usage: spiral projects create [OPTIONS]Options
| Option | Required | Default | Description |
|---|---|---|---|
-d, --description <DESCRIPTION> | no | Human-readable description for the project | |
--id-prefix <ID_PREFIX> | no | Optional ID prefix to which a random number will be appended | |
--volume <VOLUME> | no | The Volume on which the project stores its tables, such as vol_gcp_us_east4. Without it, the project uses its organization's default | |
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
spiral projects drop
Usage: spiral projects drop [OPTIONS] [PROJECT]Arguments
| Argument | Required | Default | Description |
|---|---|---|---|
PROJECT | no | Project ID. Prompted interactively when omitted on a TTY |
Options
| Option | Required | Default | Description |
|---|---|---|---|
-y, --yes | no | Skip the confirmation prompt | |
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
spiral projects grant
Usage: spiral projects grant [OPTIONS] [PROJECT]Arguments
| Argument | Required | Default | Description |
|---|---|---|---|
PROJECT | no | Project ID. Prompted interactively when omitted on a TTY |
Options
| Option | Required | Default | Description |
|---|---|---|---|
--role <ROLE> | no | Project role to grant. Prompted interactively when omitted on a TTY | |
--org-id <ORG_ID> | no | Organization ID, to grant a role to organization user(s) | |
--org-user <ORG_USER> | no | User ID. Use with --org-id | |
--org-role <ORG_ROLE> | no | Org role. Use with --org-id | |
--workload-id <WORKLOAD_ID> | no | Workload ID, to grant a role to a workload | |
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
spiral projects grants
Usage: spiral projects grants [OPTIONS] [PROJECT]Arguments
| Argument | Required | Default | Description |
|---|---|---|---|
PROJECT | no | Project ID. Prompted interactively when omitted on a TTY |
Options
| Option | Required | Default | Description |
|---|---|---|---|
--principal <PRINCIPAL> | no | Filter grants by principal string | |
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
spiral projects grant-info
Usage: spiral projects grant-info [OPTIONS] <GRANT_ID>Arguments
| Argument | Required | Default | Description |
|---|---|---|---|
GRANT_ID | yes | Grant ID |
Options
| Option | Required | Default | Description |
|---|---|---|---|
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
spiral projects revoke
Usage: spiral projects revoke [OPTIONS] <GRANT_ID>Arguments
| Argument | Required | Default | Description |
|---|---|---|---|
GRANT_ID | yes | Grant ID |
Options
| Option | Required | Default | Description |
|---|---|---|---|
-y, --yes | no | Skip the confirmation prompt | |
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
spiral projects storage
Usage: spiral projects storage [OPTIONS] [PROJECT]Arguments
| Argument | Required | Default | Description |
|---|---|---|---|
PROJECT | no | Project ID. Prompted interactively when omitted on a TTY |
Options
| Option | Required | Default | Description |
|---|---|---|---|
--volume <VOLUME> | no | Select this Volume for new tables; existing data is not moved | |
--file-system | no | Allocate through the Project's file system | |
--json | no | Emit output as JSON instead of formatted tables | |
--json-logs | no | Write structured JSON logs to standard error |
Found a problem? Edit this page or report an issue.