{"id":13516884,"url":"https://github.com/fauna/fauna-shell","last_synced_at":"2025-04-12T22:31:46.333Z","repository":{"id":32813488,"uuid":"132053891","full_name":"fauna/fauna-shell","owner":"fauna","description":"Interactive shell for FaunaDB","archived":false,"fork":false,"pushed_at":"2024-10-29T20:56:00.000Z","size":15468,"stargazers_count":75,"open_issues_count":1,"forks_count":17,"subscribers_count":24,"default_branch":"main","last_synced_at":"2024-10-29T21:38:32.876Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fauna.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-03T21:57:38.000Z","updated_at":"2024-10-29T19:38:05.000Z","dependencies_parsed_at":"2024-01-13T19:26:28.513Z","dependency_job_id":"a99a0df0-5a0a-4d6d-94b2-74bf8f5db2ec","html_url":"https://github.com/fauna/fauna-shell","commit_stats":{"total_commits":430,"total_committers":28,"mean_commits":"15.357142857142858","dds":"0.49302325581395345","last_synced_commit":"75f1678c59e5711440dad02e44df012cf38bf987"},"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fauna%2Ffauna-shell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fauna%2Ffauna-shell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fauna%2Ffauna-shell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fauna%2Ffauna-shell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fauna","download_url":"https://codeload.github.com/fauna/fauna-shell/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248640375,"owners_count":21138029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T05:01:26.835Z","updated_at":"2025-04-12T22:31:46.300Z","avatar_url":"https://github.com/fauna.png","language":"TypeScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Fauna CLI\n\n\u003c!-- [![Version](https://img.shields.io/npm/v/fauna.svg)](https://npmjs.org/package/fauna)\n[![CircleCI](https://circleci.com/gh/fauna/fauna/tree/master.svg?style=shield)](https://circleci.com/gh/fauna/fauna/tree/master)\n[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/fauna/fauna?branch=master\u0026svg=true)](https://ci.appveyor.com/project/fauna/fauna/branch/master)\n[![Codecov](https://codecov.io/gh/fauna/fauna/branch/master/graph/badge.svg)](https://codecov.io/gh/fauna/fauna)\n[![Downloads/week](https://img.shields.io/npm/dw/fauna.svg)](https://npmjs.org/package/fauna)\n[![License](https://img.shields.io/npm/l/fauna.svg)](https://github.com/fauna/fauna/blob/master/package.json) --\u003e\n\nThe Fauna CLI lets you access [Fauna](http://fauna.com/) from your terminal.\nYou can use the CLI to:\n\n- Create and manage Fauna\n  [databases](https://docs.fauna.com/fauna/current/learn/data-model/databases/).\n- Manage [database schema](https://docs.fauna.com/fauna/current/learn/schema/)\n  as `.fsl` files.\n- Run [FQL queries](https://docs.fauna.com/fauna/current/learn/query/) from\n  files or in an interactive REPL.\n- Run a local [Fauna container](https://docs.fauna.com/fauna/current/build/tools/docker/).\n\n![fauna-cli](https://github.com/user-attachments/assets/d3e88ad9-68ae-4011-945a-23654f9fbd0a)\n\n## Requirements\n\n- [Node.js](https://nodejs.org/en/download/package-manager) v20.18 or later.\n  - [Node.js](https://nodejs.org/en/download/package-manager) v22 or later recommended.\n- A Fauna account. You can sign up for a free account at https://dashboard.fauna.com/register.\n\n## Quick start\n\nTo get started:\n\n1. Install the CLI:\n\n   ```shell\n   npm install -g fauna-shell\n   ```\n\n2. If you're using bash or zsh, enable auto-complete by appending the output of\n   `fauna completion` to your `.bashrc`, `.bash_profile`, `.zshrc,` or\n   `.zprofile`. For example:\n\n   ```shell\n   fauna completion \u003e\u003e ~/.zshrc\n   ```\n\n3. Authenticate with Fauna:\n\n   ```shell\n   fauna login\n   ```\n\n4. Run CLI commands. Specify a `--database`, including the [Region\n   Group](https://docs.fauna.com/fauna/current/manage/region-groups/#id) and\n   hierarchy, to run the command in. For example:\n\n   ```shell\n   # Runs a query in the top-level 'my_db' database\n   # in the 'us' region group. Use the default admin role.\n   fauna query \"Collection.all()\" \\\n     --database us/my_db\n   ```\n\n## Installation\n\nYou can install the Fauna CLI globally using npm:\n\n```sh\nnpm install -g fauna-shell\n```\n\n## Documentation\n\nFor usage instructions and a full [list of\ncommands](https://docs.fauna.com/fauna/current/build/cli/v4/commands/), see the\n[Fauna docs](https://docs.fauna.com/fauna/current/build/cli/v4/).\n\nYou can also access help directly in the CLI:\n\n```sh\n# For general help:\nfauna --help\n\n# For a specific command:\nfauna \u003ccommand\u003e --help\n# For example:\nfauna query --help\n```\n\n## Contributions and development\n\nSee the [contribution guidelines](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffauna%2Ffauna-shell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffauna%2Ffauna-shell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffauna%2Ffauna-shell/lists"}