Start an interactive query shell.


fauna shell [DBNAME] [OPTONS]


Starts an interactive query shell for sending queries to Fauna. By default, this command runs the FQL v10. To run the shell for FQL v4, provide the --version 4 option.

It is not possible to use this command to run queries in a parent or peer database. To access a database outside of the current database, use the Fauna Dashboard.


Argument Description


Optional - If supplied, the queries that you run are executed in the child database.


Option Description


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


Optional output format. Must be one of:

- json: A simple JSON format. - json-tagged: Tagged format. In v4, this flag behaves the same as the json flag. - shell: Decorated format. This is a JavaScript-based notation that is aware of Fauna data types.

The default is shell when output is to a terminal and json when piping to another command.


Enable type checking.


Optional Fauna server domain, that is, the hostname where Fauna is running. Defaults to


Optional name of the endpoint to use for the command.


Optional connection port. Defaults to 8443.


Optional connection scheme. Must be one of https or http. Defaults to https.


Optional secret to use. A secret authenticates your connection to Fauna, and connects you to a database.


Optional connection timeout, an integer number of milliseconds. When the interval has elapsed, fauna-shell stops waiting for a response and displays an error.

The default is zero, which means that fauna-shell waits until a response is received.


Not supported.


Not supported.


$ 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!