home / databases / fauna-shell

Fauna Shell

Official · Fauna

Official Fauna CLI for running FQL queries, managing databases and schema, creating exports, and starting local Fauna containers.

$npm install -g fauna-shell
Language
JavaScript
Stars
77
Category
Databases
Agent
Ready
Agent Compatibility
JSON Output
Agent Skill
MCP Support
AI Analysis

Fauna CLI is Fauna's official command line for querying databases, managing database and schema state, creating exports, and working against a local Fauna container. It gives shell access to both day-to-day FQL work and admin flows that would otherwise go through the dashboard or HTTP APIs.

What It Enables
  • Run FQL from inline strings, files, stdin, or an interactive REPL, and write results to stdout or files.
  • Create, list, and delete databases, then pull, diff, push, commit, or abandon .fsl schema changes from local directories.
  • Create, inspect, and wait on export jobs to S3, and start a local Fauna container with an optional database and schema.
Agent Fit
  • Real structured output exists: query supports --json and --format json, while database and export commands also emit JSON on supported subcommands.
  • Most operations are regular flags-and-stdout commands, with file and stdin support that fits inspect, change, and verify loops.
  • Authentication and some schema flows are less hands-off: fauna login is browser-based by default, and schema push or schema commit prompt unless run with --no-input.
Caveats
  • The project is branded as "Fauna CLI" in the README, while fauna-shell is the package and repo name; the current directory entry uses the older naming.
  • Output formats are uneven across subcommands, with some admin and schema flows defaulting to YAML, TSV, or human-readable diffs rather than JSON.