Start an interactive Fauna session to run queries.


fauna shell [DB_PATH] [--url <value>] [--timeout <value>] [--secret <value>] [--endpoint <value>] [--environment <value>] [--file <value> ] [--stdin] [--output <value>] [--format json|json-tagged|shell] [--version 4|10] [--typecheck]


The shell command starts an interactive query shell for sending Fauna database queries.

By default, this command supports FQL v10 queries. For FQL v4 queries, use the --version 4 option.

You can’t use this command to run queries against a parent or peer database. To access a database outside of the current database, log into the Fauna Dashboard instead.


Argument Description


Database path.


Option Description


Connection endpoint, from the ~/.fauna-shell file.


Environment to use, from a Fauna project.


Name of file with queries to run.


Output format:


Help for run-queries command.


File to write output to.


Secret key. Overrides the secret in the ~/.fauna-shell file.


Read file input from stdin. Write to stdout by default.


Connection timeout (milliseconds).


Enable typechecking.


Database URL. Overrides the URL in the \~/.fauna-shell file.


FQL Version:
     4 = FQL version 4
     10 = (default) FQL version 10


Start the shell and, at the prompt, list all of the database collections using the FQL Collection.all() method:

fauna shell
Connected to
Type Ctrl+D or .exit to exit the shell
> Collection.all()
  data: [
      name: "People",
      coll: Collection,
      ts: Time("2023-08-23T00:26:16.680Z"),
      indexes: {
        byEmail: {
          terms: [
              field: "email"
          queryable: true,
          status: "complete"
      constraints: [
          unique: [
          status: "active"

Is this article helpful? 

Tell Fauna how the article can be improved:
Visit Fauna's forums or email

Thank you for your feedback!