Start an interactive Fauna session to run queries.


fauna shell [DBNAME] [OPTONS]


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


(Optional) Queries are executed against the DBNAME child database.


Option Description


(Optional) File to read the query or queries from.


(Optional) Output format. One of:

  • json: (default when piping to another command) Simple JSON format.

  • json-tagged: Tagged format.

  • shell: (default when output is to a terminal) Decorated format, which is a JavaScript-based notation that is aware of Fauna data types.


Enable type checking.


(Optional) Fauna server domain, which is the Fauna hostname.
Default =


(Optional) Endpoint name to use for the command.


(Optional) Connection port.
Default = 8443


(Optional) Connection scheme. Must be one of:
       https (default)


(Optional) Secret to use to connect to a database.


(Optional) connection timeout, in milliseconds. When the interval elapses, fauna-shell times out and displays an error.
Default = 0, wait indefinitely until a response is received.


(Optional) Fauna Query Language version
       v10 = (default) FQL v10
       v4 = FQL v4


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!