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: 2 days 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 (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T20:56:00.000Z (5 days ago)
- Last Synced: 2024-10-29T21:38:32.876Z (5 days 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:
* Log in to your Fauna account.
* Create and manage Fauna
[databases](https://docs.fauna.com/fauna/current/learn/data-model/databases/)
and [keys](https://docs.fauna.com/fauna/current/learn/security/keys/).
* Manage [database schema](https://docs.fauna.com/fauna/current/learn/schema/)
as `.fsl` files on your local machine.
* Run [FQL queries](https://docs.fauna.com/fauna/current/learn/query/) from
[files](https://docs.fauna.com/fauna/current/build/cli/commands/eval/) or in
an [interactive
shell](https://docs.fauna.com/fauna/current/build/cli/commands/shell/).
## Requirements
[Node.js](https://nodejs.org/en/download/package-manager) v18.x or later.
## Installation
Install the Fauna CLI globally using npm:
```sh
npm install -g fauna-shell
```
To upgrade the CLI, run:
```
npm update -g fauna-shell
```
## Documentation
For usage instructions and a full [list of
commands](https://docs.fauna.com/fauna/current/build/cli/commands/), see the
[Fauna docs](https://docs.fauna.com/fauna/current/build/cli/).
You can also access help directly in the CLI by running:
```sh
# For general help:
fauna --help
# For a specific command:
fauna --help
# For example:
fauna eval --help
```
## Development
To test changes during development, follow these steps:
1. Install the required packages:
```sh
yarn install
```
2. You can run commands in dev in one of two ways:
* **Option 1:** Run against the just-in-time built project with development
settings:
```sh
# Run `fauna cloud-login` in dev:
./bin/dev cloud-login
# Run `fauna eval` in dev:
./bin/dev eval
```
* **Option 2:** Run against built assets. Use `yarn link` to place them in
your `$PATH` as if globally installed:
```sh
# Build the package and place it in your $PATH:
yarn build && yarn link
# Run CLI commands using `fauna ...`:
fauna eval
```