Command Line Interface

The Taurify command line interface (CLI) is the way to interact with Taurify server and services.

List of Commands

Command	Description
init	Initialize a Taurify application for the Web app in the current working directory
dev	Run your app in development mode
run	Run your app in production mode
build	Build your app and upload to CrabNebula Cloud
update	Distribute a frontend-only update to your app via CrabNebula Cloud
keypair	Manage Taurify key pairs
keypair generate	Generate a new keypair
submit	Submit your Android app to Google Play
job	Get information of a previous build

init

npm

npm exec taurify init

yarn

yarn taurify init

pnpm

pnpm taurify init

bun

bun taurify init

cargo

cargo taurify init

Initialize a Taurify application for the Web app in the current working directory

Usage: taurify init [OPTIONS]

Options:
  -v, --verbose...  Enables verbose logging
  -h, --help        Print help
  -V, --version     Print version

dev

npm

npm exec taurify dev

yarn

yarn taurify dev

pnpm

pnpm taurify dev

bun

bun taurify dev

cargo

cargo taurify dev

Run your app in development mode

Usage: taurify dev [OPTIONS]

Options:
  -c, --config-path <CONFIG_PATH>  path to the taurify.json configuration file. Defaults to <current-dir>/taurify.json
  -v, --verbose...                 Enables verbose logging
      --mobile                     target mobile instead of desktop
  -h, --help                       Print help
  -V, --version                    Print version

run

npm

npm exec taurify run

yarn

yarn taurify run

pnpm

pnpm taurify run

bun

bun taurify run

cargo

cargo taurify run

Run your app in production mode

Usage: taurify run [OPTIONS]

Options:
  -c, --config-path <CONFIG_PATH>  path to the taurify.json configuration file. Defaults to <current-dir>/taurify.json
  -v, --verbose...                 Enables verbose logging
      --mobile                     target mobile instead of desktop
  -h, --help                       Print help
  -V, --version                    Print version

build

npm

npm exec taurify build

yarn

yarn taurify build

pnpm

pnpm taurify build

bun

bun taurify build

cargo

cargo taurify build

Build your app and upload to CrabNebula Cloud

Usage: taurify build [OPTIONS] --cn-api-key <CN_API_KEY>

Options:
  -c, --config-path <CONFIG_PATH>   path to the taurify.json configuration file. Defaults to <current-dir>/taurify.json
  -v, --verbose...                  Enables verbose logging
      --mobile                      target mobile instead of desktop
      --cn-api-key <CN_API_KEY>     CrabNebula Cloud API key to upload the artifacts [env: CN_API_KEY]
  -p, --platforms [<PLATFORMS>...]
  -h, --help                        Print help
  -V, --version                     Print version

update

npm

npm exec taurify update

yarn

yarn taurify update

pnpm

pnpm taurify update

bun

bun taurify update

cargo

cargo taurify update

Distribute a frontend-only update to your app via CrabNebula Cloud

Usage: taurify update [OPTIONS] --cn-api-key <CN_API_KEY>

Options:
  -c, --config-path <CONFIG_PATH>  path to the taurify.json configuration file. Defaults to <current-dir>/taurify.json
  -v, --verbose...                 Enables verbose logging
      --cn-api-key <CN_API_KEY>    CrabNebula Cloud API key to upload the artifacts [env: CN_API_KEY]
      --notes <NOTES>              Release notes
      --notes-file <NOTES_FILE>    Read release notes from file
  -h, --help                       Print help
  -V, --version                    Print version

keypair

npm

npm exec taurify keypair

yarn

yarn taurify keypair

pnpm

pnpm taurify keypair

bun

bun taurify keypair

cargo

cargo taurify keypair

Manage Taurify key pairs

Usage: taurify keypair [OPTIONS] <COMMAND>

Commands:
  generate  Generate a new keypair
  help      Print this message or the help of the given subcommand(s)

Options:
  -v, --verbose...  Enables verbose logging
  -h, --help        Print help
  -V, --version     Print version

keypair generate

npm

npm exec taurify keypair -- generate

yarn

yarn taurify keypair generate

pnpm

pnpm taurify keypair generate

bun

bun taurify keypair generate

cargo

cargo taurify keypair generate

Generate a new keypair

Usage: taurify keypair generate [OPTIONS]

Options:
  -c, --config-path <CONFIG_PATH>  path to the taurify.json configuration file. Defaults to <current-dir>/taurify.json
  -v, --verbose...                 Enables verbose logging
  -h, --help                       Print help
  -V, --version                    Print version

submit

npm

npm exec taurify submit

yarn

yarn taurify submit

pnpm

pnpm taurify submit

bun

bun taurify submit

cargo

cargo taurify submit

Submit your Android app to Google Play

Usage: taurify submit [OPTIONS] --service-account-key-path <SERVICE_ACCOUNT_KEY_PATH> --channel <CHANNEL>

Options:
  -f, --format <FORMAT>
          list of file formats to submit

          [possible values: apk, aab]

  -v, --verbose...
          Enables verbose logging

      --config-path <CONFIG_PATH>
          path to the taurify.json configuration file. Defaults to <current-dir>/taurify.json

      --service-account-key-path <SERVICE_ACCOUNT_KEY_PATH>
          path to the Google Service Account JSON private key used to authenticate

      --channel <CHANNEL>
          Release channel.

          Maps to a Android tracks. Common names are `alpha`, `beta`, `qa` and `production`.

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

job

npm

npm exec taurify job

yarn

yarn taurify job

pnpm

pnpm taurify job

bun

bun taurify job

cargo

cargo taurify job

Get information of a previous build

Usage: taurify job [OPTIONS] --cn-api-key <CN_API_KEY> <ID>

Arguments:
  <ID>  Build ID

Options:
      --cn-api-key <CN_API_KEY>    CrabNebula Cloud API key to upload the artifacts [env: CN_API_KEY]
  -v, --verbose...                 Enables verbose logging
  -c, --config-path <CONFIG_PATH>  path to the taurify.json configuration file. Defaults to <current-dir>/taurify.json
  -h, --help                       Print help
  -V, --version                    Print version