onboardbase-cli

• onboardbase-cli
• Usage
• Commands

Usage

$ npm install -g @onboardbase/cli
$ onboardbase COMMAND
running command...
$ onboardbase (-v|--version|version)
@onboardbase/cli/1.2.6 darwin-arm64 node-v16.11.1
$ onboardbase --help [COMMAND]
USAGE
  $ onboardbase COMMAND
...

Commands

• onboardbase build [COMMAND]
• onboardbase config:get-token
• onboardbase config:set
• onboardbase config:set-token TOKEN
• onboardbase destroy
• onboardbase environment:create
• onboardbase generateFigSpec
• onboardbase help [COMMAND]
• onboardbase login
• onboardbase logout
• onboardbase project:create
• onboardbase recommendation:create [SECRETS]
• onboardbase secrets
• onboardbase secrets:delete [SECRETS]
• onboardbase secrets:update [SECRETS]
• onboardbase secrets:upload [SECRETS]
• onboardbase setup
• onboardbase share

onboardbase build [COMMAND]

Run a command with secrets injected into the environment

USAGE
  $ onboardbase build [COMMAND]

OPTIONS
  -c, --command=command          Command to run
  -e, --environment=environment  Environment to run by default
  -h, --help                     show CLI help
  -k, --prefix=prefix            Prefix
  -p, --project=project          name of project
  -s, --passphrase=passphrase    Passphrase

See code: src/commands/build.ts

onboardbase config:get-token

Get all tokens

USAGE
  $ onboardbase config:get-token

OPTIONS
  -S, --scope=scope  scope

See code: src/commands/config/get-token.ts

onboardbase config:set

Update your onboardbase config

USAGE
  $ onboardbase config:set

OPTIONS
  -A, --api-host=api-host              API Host
  -D, --dashboard-host=dashboard-host  Dashboard Host
  -s, --scope=scope                    scope
  -t, --token=token                    Auth Token

See code: src/commands/config/set.ts

onboardbase config:set-token TOKEN

Set up Configuration token manually

USAGE
  $ onboardbase config:set-token TOKEN

OPTIONS
  -S, --scope=scope  (required) scope

See code: src/commands/config/set-token.ts

onboardbase destroy

cleanup Onboardbase artifacts including backup and authentication

USAGE
  $ onboardbase destroy

See code: src/commands/destroy.ts

onboardbase environment:create

Create an environment under a project

USAGE
  $ onboardbase environment:create

OPTIONS
  -e, --environment=environment  (required) Environment Title
  -h, --help                     show CLI help
  -p, --project=project          name of project

See code: src/commands/environment/create.ts

onboardbase generateFigSpec

Generate a Fig completion spec

USAGE
  $ onboardbase generateFigSpec

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  Output filepath

onboardbase help [COMMAND]

display help for onboardbase

USAGE
  $ onboardbase help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

onboardbase login

describe the command here

USAGE
  $ onboardbase login

OPTIONS
  --overwrite

See code: src/commands/login.ts

onboardbase logout

Log out of the CLI

USAGE
  $ onboardbase logout

See code: src/commands/logout.ts

onboardbase project:create

Create a project

USAGE
  $ onboardbase project:create

OPTIONS
  -d, --description=description  Project description
  -e, --environment=environment  Environment to run by default
  -h, --help                     show CLI help
  -t, --title=title              name of project

See code: src/commands/project/create.ts

onboardbase recommendation:create [SECRETS]

Create a recommendation

USAGE
  $ onboardbase recommendation:create [SECRETS]

OPTIONS
  -h, --help             show CLI help
  -n, --note=note        Note
  -p, --project=project  name of project

See code: src/commands/recommendation/create.ts

onboardbase secrets

Log secrets in JSON file

USAGE
  $ onboardbase secrets

OPTIONS
  -J, --json                     JSON format
  -e, --environment=environment  Environment to run by default
  -h, --help                     show CLI help
  -p, --project=project          name of project

See code: src/commands/secrets.ts

onboardbase secrets:delete [SECRETS]

Update secrets on Onboardbase

USAGE
  $ onboardbase secrets:delete [SECRETS]

OPTIONS
  -e, --environment=environment  Environment to run by default
  -h, --help                     show CLI help
  -p, --project=project          name of project

See code: src/commands/secrets/delete.ts

onboardbase secrets:update [SECRETS]

Update secrets on Onboardbase

USAGE
  $ onboardbase secrets:update [SECRETS]

OPTIONS
  -e, --environment=environment  Environment to run by default
  -h, --help                     show CLI help
  -p, --project=project          name of project

See code: src/commands/secrets/update.ts

onboardbase secrets:upload [SECRETS]

Upload secrets

USAGE
  $ onboardbase secrets:upload [SECRETS]

OPTIONS
  -e, --environment=environment  Environment to run by default
  -h, --help                     show CLI help
  -p, --project=project          name of project

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

onboardbase setup

Setup the Onboardbase CLI for managing secrets

USAGE
  $ onboardbase setup

See code: src/commands/setup.ts

onboardbase share

Share your local onboardbase.yaml secrets with a teammate

USAGE
  $ onboardbase share

OPTIONS
  -h, --help             show CLI help
  -p, --project=project  Project name

See code: src/commands/share.ts