> ## 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: service-token export const PlatformAvailability = ({current, vitess, postgres, neki}) => { const docsHref = path => { if (!path) return path; const normalized = path.startsWith('/') ? path : `/${path}`; return normalized; }; const labels = { vitess: 'Vitess', postgres: 'Postgres', neki: 'Neki' }; const combinedLabels = { both: 'Vitess and Postgres', all: 'Vitess, Neki, and Postgres', 'postgres-neki': 'Postgres and Neki' }; if (combinedLabels[current]) { return
{combinedLabels[current]}
; } const hasVitess = current === 'vitess' || Boolean(vitess); const hasPostgres = current === 'postgres' || Boolean(postgres); const hasNeki = current === 'neki' || Boolean(neki); const only = [hasVitess, hasPostgres, hasNeki].filter(Boolean).length === 1; const engines = []; if (current === 'vitess' || current === 'postgres' || current === 'neki') engines.push(current); if (hasVitess && current !== 'vitess') engines.push('vitess'); if (hasNeki && current !== 'neki') engines.push('neki'); if (hasPostgres && current !== 'postgres') engines.push('postgres'); return
{engines.map(engine => { const isCurrent = current === engine; const href = docsHref(engine === 'vitess' ? vitess : engine === 'postgres' ? postgres : neki); 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 `service-token` command This command allows you to create, list, and manage access for service tokens. **Usage:** ```bash theme={null} pscale service-token ``` ### Available sub-commands | **Sub-command** | **Sub-command flags** | **Product** | **Description** | | :--------------------------------------------------- | :--------------------------------- | :--------------------- | :---------------------------------------------------------------------------- | | `add-access ` | `--database ` | Postgres, Vitess, Neki | Add individual permissions to the specified service token in the organization | | `create` | `--name `, `--ttl ` | Postgres, Vitess, Neki | Create a service token for the organization | | `delete ` | | Postgres, Vitess, Neki | Delete an entire service token in the organization | | `delete-access ` | `--database ` | Postgres, Vitess, Neki | Delete individual permissions granted to a service token in the organization | | `list` | | Postgres, Vitess, Neki | List the IDs, names, and expiration times of an organization's service tokens | | `show ` | | Postgres, Vitess, Neki | Show a service token in the organization | | `show-access` | | Postgres, Vitess, Neki | Fetch a service token and its accesses | ### Service token automation: `service-token` Legend: ๐Ÿšซ unavailable with a service token (all sub-commands). All `service-token` sub-commands are **unavailable when authenticated with a service token**. Exact error: `pscale service-token is unavailable when authenticated with a service token`. Do not retry the CLI. Use the alternatives below. | Sub-command | Env-var auth | `--service-token` flag | Requires `--org` | Postgres / Vitess | `--format json` | API equivalent | | :---------------------------------------- | :----------: | :--------------------: | :--------------: | :---------------- | :-------------: | :------------------------------------------------------------------------------------ | | `list` | ๐Ÿšซ | ๐Ÿšซ | โœ… | Both | โœ… | `pscale api organizations//service-tokens --format json` | | `show-access ` | ๐Ÿšซ | ๐Ÿšซ | โœ… | Both | โœ… | `pscale api organizations//service-tokens/ --format json` | | `create` | ๐Ÿšซ | ๐Ÿšซ | โœ… | Both | โœ… | `pscale auth login`, then CLI; or [Service tokens API](/docs/api/reference/service-tokens) | | `add-access` / `delete-access` / `delete` | ๐Ÿšซ | ๐Ÿšซ | โœ… | Both | โœ… | `pscale auth login`, then CLI; or [Service tokens API](/docs/api/reference/service-tokens) | Read operations (`list`, `show-access`): use `pscale api` with the same service token. Create and manage operations: run under `pscale auth login`; there is no service-token CLI path for those sub-commands. Setup and commands to avoid: [CLI overview](/docs/cli) ยท [Service tokens](/docs/api/service-tokens#service-token-automation) #### 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** | **Description** | **Applicable sub-commands** | | :--------------------------- | :-------------------------------------------------------------------------------------------------- | :---------------------------- | | `--database ` | The database this project is using. | `add-access`, `delete-access` | | `--name ` | The name for the service token. | `create` | | `--ttl ` | Time to live (in seconds) for the service token. The token will be invalid when the TTL has passed. | `create` | ### Available flags | **Flag** | **Description** | | :-------------------------- | :------------------------------------ | | `-h`, `--help` | View help for `service-token` 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 ### Adding service token access for a database **Command:** ```bash theme={null} pscale service-token add-access read_branch delete_branch create_branch --database ``` This will add the following permissions to the specified access token: `read_branch`, `delete_branch`, `create_branch`. The output will show the updated permissions on all databases. You can find a list of all permissions in the [PlanetScale API documentation](/docs/api/reference/service-tokens#access-permissions). **Output:** | RESOURCE NAME | RESOURCE TYPE | ACCESSES | | :------------ | :------------ | :------------------------------------------- | | dbname | Database | read\_branch, delete\_branch, create\_branch | | dbname2 | Database | create\_branch | | my-org | Organization | create\_databases, delete\_databases | ### Adding service token access for an organization **Command:** ```bash theme={null} pscale service-token add-access read_organization ``` This will grant the service token the `read_organization` access on the organization. **Output:** | RESOURCE NAME | RESOURCE TYPE | ACCESSES | | :------------ | :------------ | :----------------- | | my-org | Organization | read\_organization | ### Show a service token ```bash theme={null} pscale service-token show ``` ## 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.