fauna-shell reference

fauna-shell is a command line tool that lets you execute Fauna queries interactively, to help you explore the capabilities of Fauna.

This section explains how to install fauna-shell and provides a reference for everything that fauna-shell can do. See Configuration for details on configuring fauna-shell.

Requirements

  • Node.js, versions 10.0.0 through 12.16.3.

Known issues

  • With Node.js 12.17.0, or newer, fauna-shell can crash when typing a period during query construction.

Installation

To install fauna-shell, issue the following command:

npm i -g fauna-shell

Command reference

Information
add-endpoint

Adds a connection endpoint for Fauna.

autocomplete

Displays autocomplete installation instructions.

cloud-login

Adds the Fauna endpoint to the configuration.

create-database

Creates a child database in the current database.

create-key

Creates a key for the specified database.

default-endpoint

Sets an endpoint as the default.

delete-database

Deletes a child database from the current database.

delete-endpoint

Deletes a connection endpoint for Fauna.

delete-key

Deletes a key.

eval

Runs the specified query.

help

Displays help for fauna command.

list-databases

Lists child databases in current database.

list-endpoints

Lists Fauna connection endpoints.

list-keys

Lists keys for the current database or its child databases.

shell

Starts an interactive shell to run Fauna queries.

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve!
Visit Fauna's Discourse forums or email docs@fauna.com

Thank you for your feedback!