FQL v4 will be decommissioned on June 30, 2025. Ensure that you complete your migration from FQL v4 to FQL v10 by that date.

For more details, see the v4 EOL announcement and migration guide. Contact support@fauna.com with any questions.

help

Display help for fauna-shell.

Syntax

fauna help [COMMAND]

Description

The fauna help command displays version and usage information for fauna-shell, and a list of all of fauna-shell commands.

fauna help COMMAND displays help for COMMAND. You can also use the syntax fauna COMMAND --help.

Arguments

Argument Description

COMMAND

Optional command name. When provided, the fauna tool displays help for the command.

Examples

To get help for the fauna-shell in general.

$ fauna help
VERSION
  fauna-shell/0.12.4 darwin-x64 node-v14.16.0

USAGE
  $ fauna [COMMAND]

COMMANDS
  add-endpoint
  cloud-login
  create-database
  create-key
  default-endpoint
  delete-database
  delete-endpoint
  delete-key
  eval
  help              display help for fauna
  list-databases
  list-endpoints
  list-keys
  run-queries
  shell

To get help for the add-endpoint command.

USAGE
  $ fauna add-endpoint ENDPOINT [--domain <value>] [--scheme https|http] [--port <value>] [--timeout <value>] [--secret <value>] [--endpoint <value>] [--alias <value>] [--key <value>]

ARGUMENTS
  ENDPOINT  FaunaDB server endpoint

FLAGS
  --alias=<value>        FaunaDB server endpoint alias
  --domain=<value>       FaunaDB server domain
  --endpoint=<value>     FaunaDB server endpoint
  --key=<value>          FaunaDB server endpoint key
  --port=<value>         Connection port
  --scheme=<option>      Connection scheme
                         <options: https|http>
  --secret=<value>       FaunaDB secret key
  --timeout=<value>      Connection timeout in milliseconds

DESCRIPTION

  Adds a connection endpoint for FaunaDB


EXAMPLES
  $ fauna add-endpoint https://db.fauna.com:443

  $ fauna add-endpoint http://localhost:8443/ --alias localhost --key secret

Is this article helpful? 

Tell Fauna how the article can be improved:
Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!