> ## Documentation Index > Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # PlanetScale CLI commands: keyspace export const PlatformAvailability = ({current, vitess, postgres}) => { const docsHref = path => { if (!path) return path; const normalized = path.startsWith('/') ? path : `/${path}`; return normalized; }; const labels = { vitess: 'Vitess', postgres: 'Postgres' }; if (current === 'both') { return

Vitess and Postgres

; } const hasVitess = current === 'vitess' || Boolean(vitess); const hasPostgres = current === 'postgres' || Boolean(postgres); const only = !(hasVitess && hasPostgres); const engines = []; if (current === 'vitess' || current === 'postgres') engines.push(current); if (hasVitess && current !== 'vitess') engines.push('vitess'); if (hasPostgres && current !== 'postgres') engines.push('postgres'); return

{engines.map(engine => { const isCurrent = current === engine; const href = docsHref(engine === 'vitess' ? vitess : postgres); const label = only ? `${labels[engine]} only` : labels[engine]; const state = isCurrent || !href ? 'current' : 'link'; if (isCurrent || !href) { return {label} ; } return {label} ; })}

; }; ## Getting started Make sure to first [set up your PlanetScale developer environment](/docs/cli/planetscale-environment-setup). Once you've installed the `pscale` CLI, you can interact with PlanetScale and manage your databases straight from the command line. ## The `keyspace` command This command allows you to view your keyspaces and view or update your Vitess VSchemas. This command is not available for Postgres databases. **Usage:** ```bash theme={null} pscale keyspace ``` ### Available sub-commands | **Sub-command** | **Sub-command flags** | **Product** | **Description** | | :---------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- | :-------------------------------------------------------------------------- | | `create ` | `--cluster-size `, `--additional-replicas `, `--shards ` | Vitess | Create a new keyspace within a database branch. | | `list ` | | Vitess | List all keyspaces within a database branch. | | `show ` | | Vitess | Show a specific keyspace within a database branch. | | `read-only-regions ` | | Vitess | List [read-only regions](/docs/vitess/scaling/read-only-regions) for a keyspace. | | `resize ` | `--cluster-size `, `--additional-replicas ` | Vitess | Resize a keyspace. | | `resize cancel ` | | Vitess | Cancel an ongoing keyspace resize. | | `resize status ` | | Vitess | Show the status of the keyspace's last resize. | | `settings ` | | Vitess | Show the settings for a keyspace. | | `update-settings ` | `-i`, `--interactive`, `--replication-durability-constraints-strategy `, `--vreplication-batch-replication-events`, `--vreplication-enable-noblob-binlog-mode`, `--vreplication-optimize-inserts` | Vitess | Update the settings for a keyspace. | | `vschema show ` | | Vitess | Show the VSchema for a sharded keyspace. Empty on non-sharded keyspaces. | | `vschema update ` | `--vschema `\* | Vitess | Update a VSchema of a keyspace. | | `rollout-status ` | | Vitess | Check the status of a keyspace resize request. | > \* *Flag is required* #### Sub-command flag descriptions | **Sub-command flag** | **Description** | **Applicable sub-commands** | | :--------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------- | :-------------------------- | | `--additional-replicas ` | `` is the number of replicas to add to the keyspace. By default, production branches include 2 replicas. | `create`, `resize` | | `--cluster-size ` | `` is the size of the database cluster. | `create`, `resize` | | `-i, --interactive` | Run the command in interactive mode. | `update-settings` | | `--replication-durability-constraints-strategy ` | Replication strategy to use. Options: maximum, dynamic, minimum (default "maximum"). | `update-settings` | | `--shards ` | Number of shards in the keyspace (default 1). | `create` | | `--vreplication-batch-replication-events` | When enabled, sends fewer queries to MySQL to improve performance. | `update-settings` | | `--vreplication-enable-noblob-binlog-mode` | When enabled, omits changed BLOB and TEXT columns from replication events, which reduces binlog sizes. (default true) | `update-settings` | | `--vreplication-optimize-inserts` | When enabled, skips sending INSERT events for rows that have yet to be replicated. (default true) | `update-settings` | | `--vschema ` | `` is the path to the updated VSchema file. | `vschema update` | ### Available flags | **Flag** | **Description** | | :-------------------------- | :------------------------------------ | | `-h`, `--help` | View help for auth command | | `--org ` | The organization for the current user | ### Global flags | **Command** | **Description** | | :------------------------------ | :----------------------------------------------------------------------------------- | | `--api-token ` | The API token to use for authenticating against the PlanetScale API. | | `--api-url ` | The base URL for the PlanetScale API. Default is `https://api.planetscale.com/`. | | `--config ` | Config file. Default is `$HOME/.config/planetscale/pscale.yml`. | | `--debug` | Enable debug mode. | | `-f`, `--format ` | Show output in a specific format. Possible values: `human` (default), `json`, `csv`. | | `--no-color` | Disable color output. | | `--service-token ` | The service token for authenticating. | | `--service-token-id ` | The service token ID for authenticating. | ## Examples ### List read-only regions for a keyspace ```bash theme={null} pscale keyspace read-only-regions ``` Output includes each region's slug, cluster size, and replica count. Use a region slug with `pscale password create ... --read-only-region` or `pscale database dump ... --read-only-region`. ## Need help? Get help from [the PlanetScale Support team](https://planetscale.com/contact?initial=support), or join our [Discord community](https://pscale.link/community) to see how others are using PlanetScale.