Fauna CLI

The Fauna CLI lets you access Fauna from your terminal.
You can use the CLI to:

- Create and manage Fauna
databases.
- Manage database schema
as .fsl files.
- Run FQL queries from
files or in an interactive REPL.
- Run a local Fauna container.

!fauna-cli

Requirements

- Node.js v20.x or later.
- A Fauna account. You can sign up for a free account at https://dashboard.fauna.com/register.

Quick start

To get started:

1. Install the CLI:

``shell
npm install -g fauna-shell
`

2. If you're using bash or zsh, enable auto-complete by appending the output of
fauna completion to your .bashrc, .bash_profile, .zshrc, or
.zprofile. For example:

`shell
fauna completion >> ~/.zshrc
`

3. Authenticate with Fauna:

`shell
fauna login
`

4. Run CLI commands. Specify a --database, including the Region
Group and
hierarchy, to run the command in. For example:

`shell
# Runs a query in the top-level 'my_db' database
# in the 'us' Region Group. Use the default admin role.
fauna query "Collection.all()" \
--database us/my_db
`

Installation

You can install the Fauna CLI globally using npm:

`sh
npm install -g fauna-shell
`

Documentation

For usage instructions and a full list of
commands, see the
Fauna docs.

You can also access help directly in the CLI:

`sh


For general help:

fauna --help

For a specific command:

fauna --help

For example:

fauna query --help
``

Contributions and development

See the contribution guidelines.