Skip to content

5 Minute Quickstart

👾

The Flybase CLI is still in development and will be released soon, this doc is being written as we develop the CLI. Things may change without notice, this warning will be removed once finalized.

Create an account

The first thing you need to do to get started with Flybase is sign up for a free account.

Once you sign up, create your first app and make a note of your API Key, and the name of your app. We’ll use this URL to store and sync data.

Usage

npm install -g flybase-cli
flybase COMMAND
running command...
flybase (-v|--version|version)
flybase-cli/1.0.3 linux-x64 node-v15.14.0
flybase --help [COMMAND]
USAGE
  flybase COMMAND
...

flybase help [COMMAND]

display help for flybase

USAGE
  flybase help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

flybase init

Initialize your flybase account

USAGE
  flybase init

OPTIONS
  -a, --app=app  app to link
  -k, --key=key  api key

DESCRIPTION
  ...
  Init your flybase account using API key from your Flybase dashboard. and an app name.

flybase test

Test connection

USAGE
  flybase test

OPTIONS
  -c, --collection=collection  collection to test

DESCRIPTION
  ...
  That's all, folks!
👾

The Flybase CLI is under active development and these commands will update as we push it.