Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fauna/fauna-shell
Interactive shell for FaunaDB
https://github.com/fauna/fauna-shell
Last synced: about 20 hours ago
JSON representation
Interactive shell for FaunaDB
- Host: GitHub
- URL: https://github.com/fauna/fauna-shell
- Owner: fauna
- License: other
- Created: 2018-05-03T21:57:38.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T20:56:00.000Z (4 months ago)
- Last Synced: 2024-10-29T21:38:32.876Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 14.8 MB
- Stars: 75
- Watchers: 24
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fauna CLI
The Fauna CLI lets you access [Fauna](http://fauna.com/) from your terminal.
You can use the CLI to:
- Create and manage Fauna
[databases](https://docs.fauna.com/fauna/current/learn/data-model/databases/).
- Manage [database schema](https://docs.fauna.com/fauna/current/learn/schema/)
as `.fsl` files.
- Run [FQL queries](https://docs.fauna.com/fauna/current/learn/query/) from
files or in an interactive REPL.
- Run a local [Fauna container](https://docs.fauna.com/fauna/current/build/tools/docker/).
## Requirements
- [Node.js](https://nodejs.org/en/download/package-manager) v20.18 or later.
- [Node.js](https://nodejs.org/en/download/package-manager) v22 or later recommended.
- A Fauna account. You can sign up for a free account at https://dashboard.fauna.com/register.
## Quick start
To get started:
1. Install the CLI:
```shell
npm install -g fauna-shell
```
2. If you're using bash or zsh, enable auto-complete by appending the output of
`fauna completion` to your `.bashrc`, `.bash_profile`, `.zshrc,` or
`.zprofile`. For example:
```shell
fauna completion >> ~/.zshrc
```
3. Authenticate with Fauna:
```shell
fauna login
```
4. Run CLI commands. Specify a `--database`, including the [Region
Group](https://docs.fauna.com/fauna/current/manage/region-groups/#id) and
hierarchy, to run the command in. For example:
```shell
# Runs a query in the top-level 'my_db' database
# in the 'us' region group. Use the default admin role.
fauna query "Collection.all()" \
--database us/my_db
```
## Installation
You can install the Fauna CLI globally using npm:
```sh
npm install -g fauna-shell
```
## Documentation
For usage instructions and a full [list of
commands](https://docs.fauna.com/fauna/current/build/cli/v4/commands/), see the
[Fauna docs](https://docs.fauna.com/fauna/current/build/cli/v4/).
You can also access help directly in the CLI:
```sh
# For general help:
fauna --help
# For a specific command:
fauna --help
# For example:
fauna query --help
```
## Contributions and development
See the [contribution guidelines](CONTRIBUTING.md).