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
plugins List installed plugins.
schema Print the diff between local and remote schema
COMMANDS
add-endpoint
cloud-login Adds a Fauna endpoint.
create-database
create-key
default-endpoint
delete-database
delete-endpoint
delete-key
eval
help Display help for fauna.
import Import data to Fauna
list-databases
list-endpoints
list-keys
plugins List installed plugins.
run-queries
shell
upload-graphql-schema Upload GraphQL schema
The |
To get help for the add-endpoint
command:
$ fauna help add-endpoint
USAGE
$ fauna add-endpoint ENDPOINT [--domain <value>] [--scheme https|http]
[--port <value>] [--timeout <value>] [--secret <value>] [--endpoint <value>]
[--graphqlHost <value>] [--graphqlPort <value>] [--alias <value>] [--key
<value>]
ARGUMENTS
ENDPOINT Fauna server endpoint
FLAGS
--alias=<value> Fauna server endpoint alias
--domain=<value> Fauna server domain
--endpoint=<value> Fauna server endpoint
--graphqlHost=<value> The Fauna GraphQL API host
--graphqlPort=<value> GraphQL port
--key=<value> Fauna server endpoint key
--port=<value> Connection port
--scheme=<option> Connection scheme
<options: https|http>
--secret=<value> Fauna secret key
--timeout=<value> Connection timeout in milliseconds
DESCRIPTION
Adds a connection endpoint for Fauna.
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!