@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.6.2 linux-x64 node-v20.12.2
$ asterai --help [COMMAND]
USAGE
  $ asterai COMMAND
...

Commands

• asterai auth KEY
• asterai deploy
• asterai help [COMMAND]
• asterai init [OUTDIR]
• asterai pkg [INPUT]
• 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 deploy

uploads a plugin to asterai

USAGE
  $ asterai deploy [-a <value>] [-e <value>] [-s] [--plugin <value>] [--pkg <value>]

FLAGS
  -a, --agent=<value>     agent ID to immediately activate this plugin for
  -e, --endpoint=<value>  [default: https://api.asterai.io]
  -s, --staging
      --pkg=<value>       [default: package.wasm] package WASM path
      --plugin=<value>    [default: plugin.wasm] plugin WASM path

DESCRIPTION
  uploads a 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] [--typescript] [--rust]

FLAGS
  --rust        init a the plugin project in rust
  --typescript  init a the plugin project in typescript

DESCRIPTION
  Initialise a new plugin project

EXAMPLES
  $ asterai init project-name

See code: src/commands/init.ts

asterai pkg [INPUT]

bundles the WIT into a binary WASM package

USAGE
  $ asterai pkg [INPUT] [-o <value>] [-w <value>] [-e <value>]

ARGUMENTS
  INPUT  [default: plugin.wit] path to the plugin's WIT file

FLAGS
  -e, --endpoint=<value>  [default: https://api.asterai.io]
  -o, --output=<value>    [default: package.wasm] output file name for the binary WASM package
  -w, --wit=<value>       [default: package.wit] output package converted to the WIT format

DESCRIPTION
  bundles the WIT into a binary WASM package

EXAMPLES
  $ asterai pkg

See code: src/commands/pkg.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