# Overview

A map of every surrealctl command group and leaf command, with links to the page documenting each one.

`surrealctl` groups its commands by noun. A group on its own prints its own help; the leaf commands below do the work. Every command accepts the [global flags](/docs/reference/cli/surrealctl/global-flags.md), and every command except [`token create`](/docs/reference/cli/surrealctl/commands/token.md#token-create) accepts `--json`.

| Group | Leaf commands |
| --- | --- |
| [`auth`](/docs/reference/cli/surrealctl/commands/auth.md) | `login`, `logout`, `status`, `refresh`, `scopes` |
| [`org`](/docs/reference/cli/surrealctl/commands/org.md) | `list`, `get`, `create`, `update`, `archive`, `use`, `roles`, `permissions`, `usage`, `spend`, `plans` |
| [`instance`](/docs/reference/cli/surrealctl/commands/instance.md) | `list`, `get`, `create`, `update`, `delete`, `pause`, `resume`, `watch`, `status`, `endpoint`, `token`, `jwks`, `sql`, `import`, `export`, `metrics`, `logs`, `usage`, `estimate`, `capabilities get`, `capabilities set`, `backup list`, `backup create`, `backup policy get`, `backup policy set` |
| [`team`](/docs/reference/cli/surrealctl/commands/team.md) | `list`, `get`, `invite`, `update`, `remove` |
| [`invite`](/docs/reference/cli/surrealctl/commands/invite.md) | `list`, `create`, `delete` |
| [`token`](/docs/reference/cli/surrealctl/commands/token.md) | `list`, `create`, `delete`, `scopes` |
| [`catalog`](/docs/reference/cli/surrealctl/commands/catalog.md) | `regions`, `instance-types`, `storage-types`, `instance-versions`, `billing-countries` |
| [`spectron`](/docs/reference/cli/surrealctl/commands/spectron.md) | `context`, `key`, `scoped-key`, `access-token`, `principal`, `package`, `scopes`, `verbs`, `providers`, `usage`, `config` |
| [`config`](/docs/reference/cli/surrealctl/commands/config.md) | `list`, `get`, `set`, `unset`, `path`, `edit` |
| [`context`](/docs/reference/cli/surrealctl/commands/context.md) | `show`, `use`, `list` |
| [Other commands](/docs/reference/cli/surrealctl/commands/misc.md) | `whoami`, `api`, `open`, `status`, `version`, `completion` |

## Aliases

Plural spellings of the group nouns work, and so do two verb aliases. Nothing else is aliased.

| Alias | Means |
| --- | --- |
| `orgs`, `instances`, `teams`, `invites`, `tokens`, `contexts` | The singular group |
| `ls` | `list` |
| `rm` | `delete` — and `team remove` |
| `doctor` | `status` |

## Reading these pages

Each leaf command gets a usage block, a table of its arguments, a table of its own options, at least one runnable example, and a note on how it refuses.

Usage blocks are notation, not commands: `<NAME>` is a value you must supply, `[NAME]` one you may, `[OPTIONS]` any number of flags, and `...` marks something repeatable. Copy from the examples instead.

Flags shared across many commands are documented once:

- The [global flags](/docs/reference/cli/surrealctl/global-flags.md), accepted everywhere.
- The [list presentation flags](/docs/reference/cli/surrealctl/output-and-exit-codes.md#list-presentation-flags) — `--columns`, `--wide`, `--no-header`, `--sort`, `--reverse` and `--limit` — carried by every list-shaped command.
- The [wait flags](/docs/reference/cli/surrealctl/long-running-operations.md#the-wait-flags) — `--wait`, `--no-wait` and `--wait-timeout` — carried by five `instance` commands.

For queries, imports, exports and running a server, use the [`surreal` CLI](/docs/reference/cli/surrealdb-cli/overview.md) instead. See the [overview](/docs/reference/cli/surrealctl/overview.md) for where that boundary sits.