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, and every command except token create accepts --json.
| Group | Leaf commands |
|---|---|
auth | login, logout, status, refresh, scopes |
org | list, get, create, update, archive, use, roles, permissions, usage, spend, plans |
instance | 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 | list, get, invite, update, remove |
invite | list, create, delete |
token | list, create, delete, scopes |
catalog | regions, instance-types, storage-types, instance-versions, billing-countries |
spectron | context, key, scoped-key, access-token, principal, package, scopes, verbs, providers, usage, config |
config | list, get, set, unset, path, edit |
context | show, use, list |
| Other commands | 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, accepted everywhere.
The list presentation flags —
--columns,--wide,--no-header,--sort,--reverseand--limit— carried by every list-shaped command.The wait flags —
--wait,--no-waitand--wait-timeout— carried by fiveinstancecommands.
For queries, imports, exports and running a server, use the surreal CLI instead. See the overview for where that boundary sits.