alphadrivecli

Tools generating a shared anatomy for autonomy.

• Usage
• Commands

Usage

$ npm install -g @alphadrive/cli
$ alpha COMMAND
running command...
$ alpha (-v|--version|version)
@alphadrive/cli/0.22.5 linux-x64 node-v12.18.2
$ alpha --help [COMMAND]
USAGE
  $ alpha COMMAND
...

Commands

• alpha account
• alpha benchmark:admin:kill [SESSION_ID]
• alpha benchmark:admin:log SESSION_ID
• alpha benchmark:admin:ps
• alpha benchmark:admin:session [SESSION_ID]
• alpha benchmark:admin:team [SESSION_ID]
• alpha benchmark:admin:team:budget
• alpha benchmark:leaderboard [SESSION_ID]
• alpha benchmark:restart SESSION_ID
• alpha benchmark:submit IMAGE
• alpha conf [KEY] [VALUE]
• alpha env
• alpha env:new NAME
• alpha env:rm
• alpha env:upload
• alpha env:versions
• alpha help [COMMAND]
• alpha init [TYPE]
• alpha login
• alpha logout
• alpha plugins
• alpha plugins:install PLUGIN...
• alpha plugins:link PLUGIN
• alpha plugins:uninstall PLUGIN...
• alpha plugins:update
• alpha run:remote IMAGE
• alpha run:stream [PROFILE]
• alpha session
• alpha session:get [SESSION_ID]
• alpha session:kill
• alpha session:log SESSION_ID
• alpha setup
• alpha update [CHANNEL]

alpha account

USAGE
  $ alpha account

OPTIONS
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

See code: src/commands/account.ts

alpha benchmark:admin:kill [SESSION_ID]

inspect benchmark session

USAGE
  $ alpha benchmark:admin:kill [SESSION_ID]

OPTIONS
  --benchmark=benchmark             (required)
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

See code: src/commands/benchmark/admin/kill.ts

alpha benchmark:admin:log SESSION_ID

download session logs

USAGE
  $ alpha benchmark:admin:log SESSION_ID

OPTIONS
  -o, --output=output               download log file to folder <output>/SESSION_ID
  --benchmark=benchmark             (required)
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

See code: src/commands/benchmark/admin/log.ts

alpha benchmark:admin:ps

list, kill, inspect benchmark sessions

USAGE
  $ alpha benchmark:admin:ps

OPTIONS
  --active
  --benchmark=benchmark             (required)
  --config=config                   [default: alphadrive.yml]
  --json
  --limit=limit                     [default: 10]
  --loglevel=error|warn|info|debug
  --page=page                       zero indexed

See code: src/commands/benchmark/admin/ps.ts

alpha benchmark:admin:session [SESSION_ID]

inspect benchmark session

USAGE
  $ alpha benchmark:admin:session [SESSION_ID]

OPTIONS
  --benchmark=benchmark             (required)
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug
  --restart
  --resume

See code: src/commands/benchmark/admin/session.ts

alpha benchmark:admin:team [SESSION_ID]

inspect benchmark team

USAGE
  $ alpha benchmark:admin:team [SESSION_ID]

OPTIONS
  --benchmark=benchmark             (required)
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

See code: src/commands/benchmark/admin/team/index.ts

alpha benchmark:admin:team:budget

inspect benchmark team

USAGE
  $ alpha benchmark:admin:team:budget

OPTIONS
  --adjustment=adjustment
  --benchmark=benchmark             (required)
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug
  --team-id=team-id                 (required)

See code: src/commands/benchmark/admin/team/budget.ts

alpha benchmark:leaderboard [SESSION_ID]

inspect benchmark team

USAGE
  $ alpha benchmark:leaderboard [SESSION_ID]

OPTIONS
  --benchmark=benchmark             (required)
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug
  --split=split                     (required)

See code: src/commands/benchmark/leaderboard.ts

alpha benchmark:restart SESSION_ID

Restart/resume a previous benchmark submission

USAGE
  $ alpha benchmark:restart SESSION_ID

OPTIONS
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug
  --resume

See code: src/commands/benchmark/restart.ts

alpha benchmark:submit IMAGE

Submit a docker image to a benchmark

USAGE
  $ alpha benchmark:submit IMAGE

OPTIONS
  -n, --dry-run
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug
  --split=split                     (required)

See code: src/commands/benchmark/submit.ts

alpha conf [KEY] [VALUE]

manage configuration

USAGE
  $ alpha conf [KEY] [VALUE]

ARGUMENTS
  KEY    key of the config
  VALUE  value of the config

OPTIONS
  -d, --cwd=cwd          config file location
  -d, --delete           delete?
  -h, --help             show CLI help
  -k, --key=key          key of the config
  -n, --name=name        config file name
  -p, --project=project  project name
  -v, --value=value      value of the config

See code: conf-cli

alpha env

list, environments

USAGE
  $ alpha env

OPTIONS
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

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

alpha env:new NAME

list, environments

USAGE
  $ alpha env:new NAME

ARGUMENTS
  NAME  name of new environment

OPTIONS
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

See code: src/commands/env/new.ts

alpha env:rm

list, environments

USAGE
  $ alpha env:rm

OPTIONS
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

See code: src/commands/env/rm.ts

alpha env:upload

upload, environments

USAGE
  $ alpha env:upload

OPTIONS
  -n, --version-name=version-name   (required) Name of new version
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

See code: src/commands/env/upload.ts

alpha env:versions

list, environments

USAGE
  $ alpha env:versions

OPTIONS
  --config=config                   [default: alphadrive.yml]
  --environment=environment         (required)
  --loglevel=error|warn|info|debug

See code: src/commands/env/versions.ts

alpha help [COMMAND]

display help for alpha

USAGE
  $ alpha help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

alpha init [TYPE]

download sample projects. Try "alpha init demo"

USAGE
  $ alpha init [TYPE]

See code: src/commands/init.ts

alpha login

login to Alpha Drive to start training and testing your AI.

USAGE
  $ alpha login

OPTIONS
  -q, --no-prompt                   Don't open a browser when activating
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

See code: src/commands/login.ts

alpha logout

USAGE
  $ alpha logout

OPTIONS
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

See code: src/commands/logout.ts

alpha plugins

list installed plugins

USAGE
  $ alpha plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ alpha plugins

See code: @oclif/plugin-plugins

alpha plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ alpha plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -f, --force    yarn install with force flag
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Can be installed from npm or a git url.

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

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ alpha plugins:add

EXAMPLES
  $ alpha plugins:install myplugin 
  $ alpha plugins:install https://github.com/someuser/someplugin
  $ alpha plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

alpha plugins:link PLUGIN

links a plugin into the CLI for development

USAGE
  $ alpha plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  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.

EXAMPLE
  $ alpha plugins:link myplugin

See code: @oclif/plugin-plugins

alpha plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ alpha plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

ALIASES
  $ alpha plugins:unlink
  $ alpha plugins:remove

See code: @oclif/plugin-plugins

alpha plugins:update

update installed plugins

USAGE
  $ alpha plugins:update

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

See code: @oclif/plugin-plugins

alpha run:remote IMAGE

Submit a docker image to a benchmark

USAGE
  $ alpha run:remote IMAGE

OPTIONS
  -n, --dry-run
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug
  --simulator=simulator             [default: carlasim/carla:0.9.5]

See code: src/commands/run/remote.ts

alpha run:stream [PROFILE]

launch a simulator in cloud to train, test or validate your AI agent running locally.

USAGE
  $ alpha run:stream [PROFILE]

OPTIONS
  -h, --help                        show CLI help
  -p, --pool=pool
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug
  --wsdebug

ALIASES
  $ alpha drive

See code: src/commands/run/stream.ts

alpha session

list, kill, inspect sessions

USAGE
  $ alpha session

OPTIONS
  --active
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

ALIASES
  $ alpha sessions
  $ alpha ps

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

alpha session:get [SESSION_ID]

List sessions

USAGE
  $ alpha session:get [SESSION_ID]

OPTIONS
  --active
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

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

alpha session:kill

Kill an instance

USAGE
  $ alpha session:kill

OPTIONS
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

ALIASES
  $ alpha kill

See code: src/commands/session/kill.ts

alpha session:log SESSION_ID

download session logs

USAGE
  $ alpha session:log SESSION_ID

OPTIONS
  -o, --output=output               download log file to folder <output>/SESSION_ID
  --config=config                   [default: alphadrive.yml]
  --loglevel=error|warn|info|debug

See code: src/commands/session/log.ts

alpha setup

create alphadrive.yml in current directory and configure your agent work area for use with the AlphaDrive simulator services.

USAGE
  $ alpha setup

See code: src/commands/setup.ts

alpha update [CHANNEL]

update the alpha CLI

USAGE
  $ alpha update [CHANNEL]

See code: @oclif/plugin-update