@brale/cli v0.1.2

Brale CLI

The Brale CLI is a command-line interface designed to simplify and streamline common API interactions with the Brale API. Brale provides a range of services used create a stablecoin, and this CLI offers a convenient way to access those features directly from the command line.

Under the hood, the CLI uses oclif for the UX and generates Brale API definitions using the openapi-generator-cli based on our OpenAPI file.

• Brale CLI
• Usage
• Commands

Usage

To get started, you'll need to have an API application created and access to the client ID and client secret. After installing, you'll need to configure the CLI with your API credentials:

$ npm install -g @brale/cli
$ brale configure --client-id $CLIENT_ID --client-secret $CLIENT_SECRET
$ brale --help [COMMAND]
USAGE
  $ brale COMMAND
...

Commands

• brale addresses
• brale base
• brale configure
• brale financial-institutions
• brale help [COMMAND]
• brale mint TICKER
• brale orders get ID
• brale orders transactions ID
• brale plugins
• brale plugins add PLUGIN
• brale plugins:inspect PLUGIN...
• brale plugins install PLUGIN
• brale plugins link PATH
• brale plugins remove [PLUGIN]
• brale plugins reset
• brale plugins uninstall [PLUGIN]
• brale plugins unlink [PLUGIN]
• brale plugins update
• brale redeem TICKER
• brale tokens
• brale tokens deployments TICKER
• brale update [CHANNEL]

brale addresses

List addresses

USAGE
  $ brale addresses [--json] [-r] [-t <value>]

FLAGS
  -r, --raw           Output raw JSON (defaults to a table)
  -t, --type=<value>  Filter by address type

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List addresses

See code: src/commands/addresses/index.ts

brale base

USAGE
  $ brale base [--json] [-r]

FLAGS
  -r, --raw  Output raw JSON (defaults to a table)

GLOBAL FLAGS
  --json  Format output as json.

See code: src/commands/base.ts

brale configure

Configure API credentials

USAGE
  $ brale configure -i <value> -s <value> [--json] [-r] [-h <value>] [-a <value>]

FLAGS
  -a, --auth-host=<value>      Token Auth Host
  -h, --api-host=<value>       API Host
  -i, --client-id=<value>      (required) API Client ID
  -r, --raw                    Output raw JSON (defaults to a table)
  -s, --client-secret=<value>  (required) API Client Secret

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Configure API credentials

See code: src/commands/configure/index.ts

brale financial-institutions

List financial institutions

USAGE
  $ brale financial-institutions [--json] [-r]

FLAGS
  -r, --raw  Output raw JSON (defaults to a table)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List financial institutions

See code: src/commands/financial-institutions/index.ts

brale help [COMMAND]

Display help for brale.

USAGE
  $ brale help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for brale.

See code: @oclif/plugin-help

brale mint TICKER

Mint tokens

USAGE
  $ brale mint TICKER -a <value> -c <value> -d <value> [--json] [-r] [-n <value>] [-q <value> -p USDC|wire]

ARGUMENTS
  TICKER  The ticker of the token to mint

FLAGS
  -a, --amount=<value>         (required) The amount to mint
  -c, --chain=<value>          (required) The chain ID of the deployment/chain to mint on
  -d, --destination=<value>    (required) The destination address ID
  -n, --note=<value>           A note to add to the order
  -p, --payment=<option>       [default: wire] Payment
                               <options: USDC|wire>
  -q, --payment-chain=<value>  The USDC chain to pay from
  -r, --raw                    Output raw JSON (defaults to a table)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Mint tokens

See code: src/commands/mint/index.ts

brale orders get ID

Get order

USAGE
  $ brale orders get ID [--json] [-r]

ARGUMENTS
  ID  The id of the Order

FLAGS
  -r, --raw  Output raw JSON (defaults to a table)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get order

See code: src/commands/orders/get.ts

brale orders transactions ID

Get an order's transactions

USAGE
  $ brale orders transactions ID [--json] [-r]

ARGUMENTS
  ID  The id of the Order

FLAGS
  -r, --raw  Output raw JSON (defaults to a table)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get an order's transactions

See code: src/commands/orders/transactions.ts

brale plugins

List installed plugins.

USAGE
  $ brale plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ brale plugins

See code: @oclif/plugin-plugins

brale plugins add PLUGIN

Installs a plugin into brale.

USAGE
  $ brale plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into brale.

  Uses bundled npm executable to install plugins into /home/runner/.local/share/brale

  Installation of a user-installed plugin will override a core plugin.

  Use the BRALE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the BRALE_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ brale plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ brale plugins add myplugin

  Install a plugin from a github url.

    $ brale plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ brale plugins add someuser/someplugin

brale plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ brale plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ brale plugins inspect myplugin

See code: @oclif/plugin-plugins

brale plugins install PLUGIN

Installs a plugin into brale.

USAGE
  $ brale plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into brale.

  Uses bundled npm executable to install plugins into /home/runner/.local/share/brale

  Installation of a user-installed plugin will override a core plugin.

  Use the BRALE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the BRALE_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ brale plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ brale plugins install myplugin

  Install a plugin from a github url.

    $ brale plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ brale plugins install someuser/someplugin

See code: @oclif/plugin-plugins

brale plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ brale plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ brale plugins link myplugin

See code: @oclif/plugin-plugins

brale plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ brale plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ brale plugins unlink
  $ brale plugins remove

EXAMPLES
  $ brale plugins remove myplugin

brale plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ brale plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

brale plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ brale plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ brale plugins unlink
  $ brale plugins remove

EXAMPLES
  $ brale plugins uninstall myplugin

See code: @oclif/plugin-plugins

brale plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ brale plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ brale plugins unlink
  $ brale plugins remove

EXAMPLES
  $ brale plugins unlink myplugin

brale plugins update

Update installed plugins.

USAGE
  $ brale plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

brale redeem TICKER

Redeem/burn tokens

USAGE
  $ brale redeem TICKER -a <value> -c <value> [--json] [-r] [-d <value> -p USDC|wire] [-f <value> ] [-n
    <value>] [-q <value> ]

ARGUMENTS
  TICKER  The ticker of the token to redeem/burn

FLAGS
  -a, --amount=<value>                 (required) The amount to redeem
  -c, --chain=<value>                  (required) The chain ID of the deployment/chain to redeem from
  -d, --address=<value>                The ID of the address you want to receive the USDC (if applicable)
  -f, --financial-institution=<value>  The destination financial institution ID
  -n, --note=<value>                   A note to add to the order
  -p, --payment=<option>               Payment
                                       <options: USDC|wire>
  -q, --payment-chain=<value>          The USDC chain to pay to
  -r, --raw                            Output raw JSON (defaults to a table)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Redeem/burn tokens

See code: src/commands/redeem/index.ts

brale tokens

List addresses

USAGE
  $ brale tokens [--json] [-r] [-t <value>]

FLAGS
  -r, --raw             Output raw JSON (defaults to a table)
  -t, --ticker=<value>  The ticker to filter by

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List addresses

See code: src/commands/tokens/index.ts

brale tokens deployments TICKER

List addresses

USAGE
  $ brale tokens deployments TICKER [--json] [-r] [-c <value>]

ARGUMENTS
  TICKER  The ticker of the token to get deployments for

FLAGS
  -c, --chain=<value>  The chain id to filter by
  -r, --raw            Output raw JSON (defaults to a table)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List addresses

See code: src/commands/tokens/deployments.ts

brale update [CHANNEL]

update the brale CLI

USAGE
  $ brale update [CHANNEL] [-a] [--force] [-i | -v <value>]

FLAGS
  -a, --available        See available versions.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
      --force            Force a re-download of the requested version.

DESCRIPTION
  update the brale CLI

EXAMPLES
  Update to the stable channel:

    $ brale update stable

  Update to a specific version:

    $ brale update --version 1.0.0

  Interactively select version:

    $ brale update --interactive

  See available versions:

    $ brale update --available

See code: @oclif/plugin-update