@based/cli

Streamline your app development with our cli.
Based.io offers a real-time database and makes deploying to the cloud fast and easy,
letting you focus on building your app without the hassle.

Simple usage

_Example:_ npx @based/cli@alpha [commands][sub-commands][options]

When you created your account on Based.io, you also needed to create a cluster or an organization,
name your project, and choose an environment to start developing your app.

Once you have this information, you can continue to the authentication process.

During your first interaction with the CLI,
you will need to provide your username used to create your account on Based.io.
After validating your login, you're able to run any command with the CLI.

You can choose between three methods to interact with the CLI:

The first and recommended method is to create a configuration file called based.ts or based.json
at the root of your project, which should look something like this:

``typescript
export default {
org: 'my-org',
project: 'my-project',
env: '#branch', // or any other name you have chosen
}
`

For branch deployment you can also use something like this in your based.ts:
`typescript
export default {
org: 'my-org',
project: 'my-project',
env: 'main/#branch', // with this you set that you want to deploy your branch but cloning all the data from the env 'main'
}
`
If any selected env is missing from your account, the CLI will offer to create it before proceeding with the deployment.

You can also use an API Key if you're setting up a CI/CD, like this:

`typescript
export default {
apiKey: 'my-key',
}
`

_To get an API Key, go to Based.io._

The second method is to use the authentication parameters with each CLI interaction.
You can use --org, --project, and --env or just --api-key
followed by the corresponding information for each parameter.

If you decide to create the file at the root of your project,
there is no need to pass any of the authentication parameters when executing CLI commands;
they are all optional.
However, if you provide any of the authentication parameters in a project that has the based.json file,
the information passed as a parameter will take precedence over the file.

Commands

$3

The CLI has some global options that can be used from any command. These options, when used on the command line, have precedence over any other option related to your project. For example, after configuring your 'based.(ts|js|json)' file to use the project 'my-first-project', and you use the option --project my-second-project on the command line, that option will be used instead. Therefore, if you want to configure your project for CI/CD, you can pass all the parameters you need on the command line.

| Option | Description |
|--------|-------------|
| --display | Sets the logging level for the CLI output (available levels: log / verbose / debug / silent). |
| -y, --yes | You can use this to skip all the prompts and use a predefined preset in some commands. |
| -c, --cluster | Define the cluster to use. |
| -o, --org | Specify the organization. |
| -p, --project | Specify the project name. |
| -e, --env | Specify which environment (can be a name or "#branch" if you want to deploy by branch). |
| --api-key | API Key generated on Based.io for Service Account. |
| --file | If you want to use a specific Based configuration file. All other project options take precedence over this option. |
| -ed, --envDiscoveryUrl | If you want to define a specific URL from a different environment to connect to. |
| -pd, --platformDiscoveryUrl | If you want to define a specific URL from a different platform to connect to. |

$3

Disconnect your user locally.

_Example:_ npx @based/cli disconnect

$3

Authorize your user in the Based Cloud.

_Example:_ npx @based/cli auth

| Option | Description |
|--------|-------------|
| --email | To speed up the login process. |

$3

_Example:_ npx @based/cli init [options]

| Option | Description |
|--------|-------------|
| -n, --name | Give a name to your project. |
| -d, --description | Give a description to your project. |
| --path | The path to save the Based Project File. |
| --format | The extension of file you prefer (available formats: ts, js, json). |
| -dp, --dependencies | Choose the dependencies you want to be added to your project (available tools: typescript, vitest, biome, react). |
| --queries | You can pre-create your Based Query Functions. |
| -f, --functions | You can pre-create your Based Cloud Functions. |

$3

Backup and restore your databases.

_Example:_ npx @based/cli backup [sub-command][options]

#### Make

Backup current environment state.

#### List

List available backups.

| Option | Description |
|--------|-------------|
| -l, --limit | Limit the number of displayed backups (all: 0). |
| -s, --sort | Sort the order of the backups asc/desc. |

#### Download

Download previous backups.

| Option | Description |
|--------|-------------|
| --db | DB instance name. |
| --file | The '.rdb' backup file to be downloaded. This option takes precedence over the '--date' option. |
| -d, --date