# PlanetScale module arguments Generated from [the CLI catalog](../../lib/cli/catalog.json). Every export requires a fresh `runDir`. Common fields are `project` (default `.`), `executable` (the CLI program or path), `timeoutMs` (default `900000`), and `artifacts` is a comma-separated NAME=PATH string in the public component contract. ## `run` Execute any PlanetScale CLI feature with literal CSV arguments. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `arguments` | `string (CSV)` | `` | Required | ## `version` Print the installed pscale CLI version. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | ## `agents` Run the complete pscale agents command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `login` Run the complete pscale login command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `logout` Run the complete pscale logout command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `agent_guide` Run the complete pscale agent-guide command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `api` Run the complete pscale api command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `audit_log` Run the complete pscale audit-log command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `auth` Run the complete pscale auth command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `billing` Run the complete pscale billing command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `completion` Run the complete pscale completion command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `org` Run the complete pscale org command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `ping` Run the complete pscale ping command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `region` Run the complete pscale region command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `signup` Run the complete pscale signup command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `size` Run the complete pscale size command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `service_token` Run the complete pscale service-token command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `backup` Run the complete pscale backup command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `branch` Run the complete pscale branch command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `database` Run the complete pscale database command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `insights` Run the complete pscale insights command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `inspect` Run the complete pscale inspect command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `logs` Run the complete pscale logs command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `metrics` Run the complete pscale metrics command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `webhook` Run the complete pscale webhook command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `connect` Run the complete pscale connect command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `deploy_request` Run the complete pscale deploy-request command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `keyspace` Run the complete pscale keyspace command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `maintenance` Run the complete pscale maintenance command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `password` Run the complete pscale password command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `shell` Run the complete pscale shell command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `import_command` Run the complete pscale import command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `sql` Run the complete pscale sql command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `workflow` Run the complete pscale workflow command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `role_command` Run the complete pscale role command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `pgbouncer` Run the complete pscale pgbouncer command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `dedicated_read_replica` Run the complete pscale dedicated-read-replica command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `read_only_replica` Run the complete pscale read-only-replica command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `traffic_control` Run the complete pscale traffic-control command surface, including every nested subcommand and native flag. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `branch_create` Create a preview branch and wait for readiness by default. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `database` | `string` | `` | Required | | `branch` | `string` | `` | Required | | `organization` | `string` | `--org=` | Omitted | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `fromBranch` | `string` | `--from=` | Omitted | | `region` | `string` | `--region=` | Omitted | | `clusterSize` | `string` | `--cluster-size=` | Omitted | | `wait` | `boolean` | `--wait` | `true` | | `arguments` | `string (CSV)` | `` | Omitted | ## `branch_list` List database branches for preview environment discovery. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `database` | `string` | `` | Required | | `organization` | `string` | `--org=` | Omitted | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `branch_show` Inspect a database branch and its readiness information. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `database` | `string` | `` | Required | | `branch` | `string` | `` | Required | | `organization` | `string` | `--org=` | Omitted | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `branch_delete` Delete a preview branch during pipeline cleanup. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `database` | `string` | `` | Required | | `branch` | `string` | `` | Required | | `organization` | `string` | `--org=` | Omitted | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `force` | `boolean` | `--force` | Omitted | | `deleteDescendants` | `boolean` | `--delete-descendants` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `branch_schema` Retrieve a branch schema for inspection or artifact collection. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `database` | `string` | `` | Required | | `branch` | `string` | `` | Required | | `organization` | `string` | `--org=` | Omitted | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `database_list` List databases visible to the pipeline credentials. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `organization` | `string` | `--org=` | Omitted | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `deploy_request_create` Open a schema deploy request from a branch. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `database` | `string` | `` | Required | | `branch` | `string` | `` | Required | | `organization` | `string` | `--org=` | Omitted | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `into` | `string` | `--into=` | Omitted | | `notes` | `string` | `--notes=` | Omitted | | `autoDeleteBranch` | `boolean` | `--auto-delete-branch` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `deploy_request_show` Inspect a deploy request before applying schema changes. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `database` | `string` | `` | Required | | `request` | `string` | `` | Required | | `organization` | `string` | `--org=` | Omitted | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `deploy_request_diff` Inspect schema changes in a deploy request. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `database` | `string` | `` | Required | | `requestNumber` | `integer` | `` | Required | | `organization` | `string` | `--org=` | Omitted | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `deploy_request_deploy` Deploy a schema request and wait for completion by default. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `database` | `string` | `` | Required | | `request` | `string` | `` | Required | | `organization` | `string` | `--org=` | Omitted | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `wait` | `boolean` | `--wait` | `true` | | `strategy` | `string (serial, parallel)` | `--strategy=` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted | ## `sql_query` Execute a noninteractive SQL query and propagate query failures. | Field | Type | CLI argument | Default / required | | --- | --- | --- | --- | | `database` | `string` | `` | Required | | `branch` | `string` | `` | Required | | `organization` | `string` | `--org=` | Omitted | | `outputFormat` | `string (human, json, csv)` | `--format=` | Omitted | | `query` | `string` | `--query=` | Required | | `role` | `string` | `--role=` | Omitted | | `dbname` | `string` | `--dbname=` | Omitted | | `keyspace` | `string` | `--keyspace=` | Omitted | | `replica` | `boolean` | `--replica` | Omitted | | `force` | `boolean` | `--force` | Omitted | | `arguments` | `string (CSV)` | `` | Omitted |