help
Display the Fauna Shell help.
Description
The help
command displays version, usage, and a list of supported
fauna-shell topics and commands.
Include the COMMAND argument to display the help for a given topic or command.
Examples
To get general help:
$ fauna help
faunadb shell
VERSION
fauna-shell/1.1.0 linux-x64 node-v18.8.0
USAGE
$ fauna [COMMAND]
TOPICS
endpoint Manage endpoints in ~/.fauna-shell.
schema Manage database schema
project Manage project settings in .fauna-project.
environment Manage environments in the current project.
COMMANDS
add-endpoint Add an endpoint to ~/.fauna-shell.
cloud-login Log in to a Fauna account.
create-database Create a database.
create-key Create a key for the specified database.
default-endpoint Set an endpoint as the default one.
delete-database Delete a database.
delete-endpoint Remove an endpoint from ~/.fauna-shell.
delete-key Delete a key.
eval Evaluate the given query.
help Display help for fauna.
import Import data to Fauna
list-databases List databases.
list-endpoints List endpoints in ~/.fauna-shell.
list-keys List keys in the current database.
run-queries Run the queries found on the file passed to the command.
shell Start an interactive shell.
upload-graphql-schema Upload GraphQL schema
The |
To get help for the add-endpoint
command:
$ fauna help add-endpoint
USAGE
$ fauna add-endpoint [NAME] [--non-interactive --url <value> --secret <value>] [--set-default]
ARGUMENTS
Name Endpoint name
FLAGS
--non-interactive Disables interaction
--secret=<value> Database secret
--set-default Sets this environment as the default
--url=<value> Database URL
DESCRIPTION
Add an endpoint to ~/.fauna-shell.
ALIASES
$ fauna add-endpoint
EXAMPLES
$ fauna endpoint add
$ fauna endpoint add localhost --url http://localhost:8443/ --key secret
$ fauna endpoint add localhost --set-default
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!