SurrealDB CLI

A skill for driving the surreal command-line binary — SurrealDB's all-in-one tool for running a server, querying it, and moving data in and out.

This skill covers operating the surreal binary itself. To write the SurrealQL that you run with it, use the surrealql skill; for declarative schema migrations and type generation, use the surrealkit skill.

When to use this skill

Reference these guidelines when:

• Starting a SurrealDB server, locally or in a container (surreal start)
• Opening the SQL shell or piping queries from a file (surreal sql)
• Importing or exporting a database for backups, seeding, or migration (surreal import / surreal export)
• Gating scripts or CI on server availability (surreal is-ready)
• Upgrading the binary or repairing on-disk storage after an upgrade (surreal upgrade / surreal fix)
• Importing or exporting SurrealML models (surreal ml)

Installation