@asterai/cli

CLI for building and deploying asterai plugins

• @asterai/cli
• Usage
• Commands

Usage

$ npm install -g @asterai/cli
$ asterai COMMAND
running command...
$ asterai (--version)
@asterai/cli/0.4.0 linux-x64 node-v20.12.2
$ asterai --help [COMMAND]
USAGE
  $ asterai COMMAND
...

Commands

• asterai auth KEY
• asterai build [INPUT]
• asterai codegen
• asterai deploy [INPUT]
• asterai help [COMMAND]
• asterai init [OUTDIR]
• asterai query

asterai auth KEY

authenticate to asterai

USAGE
  $ asterai auth KEY

DESCRIPTION
  authenticate to asterai

EXAMPLES
  $ asterai auth

See code: src/commands/auth.ts

asterai build [INPUT]

compiles the plugin

USAGE
  $ asterai build [INPUT] [-m <value>]

FLAGS
  -m, --manifest=<value>  [default: plugin.asterai.proto] manifest path

DESCRIPTION
  compiles the plugin

EXAMPLES
  $ asterai build

See code: src/commands/build.ts

asterai codegen

Generate code from the plugin manifest

USAGE
  $ asterai codegen [-m <value>] [-o <value>] [-a <value>] [-l <value>] [-s]

FLAGS
  -a, --appId=<value>      app id
  -l, --language=<value>   [default: js] language of generated typings
  -m, --manifest=<value>   [default: plugin.asterai.proto] manifest path
  -o, --outputDir=<value>  [default: generated] output directory
  -s, --staging            use staging endpoint

DESCRIPTION
  Generate code from the plugin manifest

EXAMPLES
  $ asterai codegen

See code: src/commands/codegen.ts

asterai deploy [INPUT]

compiles and uploads the plugin to asterai

USAGE
  $ asterai deploy [INPUT] -a <value> [-m <value>] [-e <value>] [-s]

FLAGS
  -a, --app=<value>       (required) app ID to immediately configure this plugin with
  -e, --endpoint=<value>  [default: https://api.asterai.io/app/plugin]
  -m, --manifest=<value>  [default: plugin.asterai.proto] manifest path
  -s, --staging

DESCRIPTION
  compiles and uploads the plugin to asterai

EXAMPLES
  $ asterai deploy --app 66a46b12-b1a7-4b72-a64a-0e4fe21902b6

See code: src/commands/deploy.ts

asterai help [COMMAND]

Display help for asterai.

USAGE
  $ asterai 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 asterai.

See code: @oclif/plugin-help

asterai init [OUTDIR]

Initialise a new plugin project

USAGE
  $ asterai init [OUTDIR]

DESCRIPTION
  Initialise a new plugin project

EXAMPLES
  $ asterai init project-name

See code: src/commands/init.ts

asterai query

query an asterai app interactively

USAGE
  $ asterai query -a <value> -k <value> [-s] [-e <value>]

FLAGS
  -a, --app=<value>       (required)
  -e, --endpoint=<value>  [default: https://api.asterai.io]
  -k, --key=<value>       (required) app query key
  -s, --staging

DESCRIPTION
  query an asterai app interactively

EXAMPLES
  $ asterai query

See code: src/commands/query.ts