;
};
## 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 `workflow` command
This command allows you to create and manage [workflows](/docs/vitess/scaling/workflows) for Vitess databases, including creating workflows, listing them, and performing actions like traffic switching and cutover. This command is not supported for Postgres databases.
The `create` sub-command is for [table movement workflows](/docs/vitess/scaling/workflows#table-movement-workflows) only (moving tables between keyspaces). [Database import workflows](/docs/vitess/imports/database-imports) must be created through the PlanetScale dashboard. Once created, all other sub-commands (`list`, `show`, `switch-traffic`, `verify-data`, `complete`, `cancel`, etc.) work with both workflow types.
**Usage:**
```bash theme={null}
pscale workflow
```
### Available sub-commands
| **Sub-command** | **Sub-command flags** | **Product** | **Description** |
| :-------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- | :---------------------------------------------------------------------- |
| `cancel ` | `--force` | Vitess | Cancel a workflow that is in progress |
| `complete ` | | Vitess | Mark a workflow as complete |
| `create ` | `--defer-secondary-keys`, `--global-keyspace `, `-i`, `--interactive`, `--name `, `--on-ddl `, `--source-keyspace `, `--tables `, `--target-keyspace ` | Vitess | Create a new workflow within a branch |
| `cutover ` | `--force` | Vitess | Completes the workflow, cutting over all traffic to the target keyspace |
| `list ` | | Vitess | List all of the workflows for a PlanetScale database |
| `retry ` | | Vitess | Retry a workflow that has been stopped or failed |
| `reverse-cutover ` | | Vitess | Reverse the cutover of a workflow back to the source keyspace |
| `reverse-traffic ` | | Vitess | Route queries back to the source keyspace for a specific workflow |
| `show ` | | Vitess | Show a specific workflow for a PlanetScale database |
| `switch-traffic ` | `--force`, `--replicas-only` | Vitess | Route queries to the target keyspace for a specific workflow |
| `verify-data ` | | Vitess | Verify data consistency for a specific workflow |
#### Sub-command flag descriptions
Some of the sub-commands have additional flags unique to the sub-command. This section covers what each of those does. See the above table for which context.
| **Sub-command flag** | **Type** | **Description** | **Applicable sub-commands** |
| :---------------------------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------ |
| `--defer-secondary-keys` | boolean | Don't create secondary indexes for tables until they've been copied (default true) | `create` |
| `--force` | boolean | Force the operation without prompting for confirmation | `cancel`, `cutover`, `switch-traffic` |
| `--global-keyspace ` | string | Choose an unsharded keyspace where sequence tables will be created for any workflow table that contains AUTO\_INCREMENT | `create` |
| `-i, --interactive` | boolean | Create the workflow in interactive mode | `create` |
| `--name ` | string | Name of the workflow | `create` |
| `--on-ddl ` | string | Action to take when a DDL statement is encountered during a running workflow. Options: EXEC, EXEC\_IGNORE, STOP, IGNORE (default "STOP") | `create` |
| `--replicas-only` | boolean | Route read queries from the replica and read-only tablets to the target keyspace | `switch-traffic` |
| `--source-keyspace ` | string | Keyspace where the tables will be copied from | `create` |
| `--tables ` | strings | Tables to migrate to the target keyspace | `create` |
| `--target-keyspace ` | string | Keyspace where the tables will be copied to | `create` |
### Available flags
| **Flag** | **Description** |
| :-------------------------- | :------------------------------------ |
| `-h`, `--help` | View help for workflow 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. |
## 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.