onboardbase-cli

• onboardbase-cli
• Usage
• Commands

Usage

$ npm install -g @onboardbase/cli
$ onboardbase COMMAND
running command...
$ onboardbase (-v|--version|version)
@onboardbase/cli/8.1.8 linux-x64 node-v16.14.2
$ onboardbase --help [COMMAND]
USAGE
  $ onboardbase COMMAND
...

Commands

• onboardbase auth [COMMAND]
• onboardbase build [COMMAND]
• onboardbase config:get-token
• onboardbase config:set
• onboardbase destroy
• onboardbase disposable:share [FILE]
• onboardbase environment:create
• onboardbase generateFigSpec
• onboardbase help [COMMAND]
• onboardbase init
• onboardbase integrations:railway
• onboardbase login
• onboardbase logout
• onboardbase project:create
• onboardbase recommendation:create [SECRETS]
• onboardbase run [COMMAND]
• onboardbase scan
• onboardbase secrets [FORMAT]
• onboardbase secrets:delete [SECRETS]
• onboardbase secrets:download [FORMAT]
• onboardbase secrets:fetch [SECRET-KEY]
• onboardbase secrets:update [SECRETS]
• onboardbase secrets:upload [SECRETS]
• onboardbase setup
• onboardbase share
• onboardbase teammate
• onboardbase tf [COMMAND]
• onboardbase tf:decrypt
• onboardbase tf:download
• onboardbase tf:encrypt
• onboardbase tf:upload
• onboardbase update

onboardbase auth [COMMAND]

A one stop command for authenticating, setting up a project and running the project

USAGE
  $ onboardbase auth [COMMAND]

OPTIONS
  -c, --command=command  Command to run
  -h, --help             show CLI help
  --overwrite
  --password=password    Password
  --verbose              Enable warning/error logs

See code: src/commands/auth.ts

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
  --live-reload                  Live Reload

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
  --password=password                  Password
  --re-authenticate

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

onboardbase destroy

cleanup Onboardbase artifacts including backup and authentication

USAGE
  $ onboardbase destroy

See code: src/commands/destroy.ts

onboardbase disposable:share [FILE]

Share sensitive files securely and quickly with end-to-end encryption and automatic deletion

USAGE
  $ onboardbase disposable:share [FILE]

OPTIONS
  -e, --expires=5|30|60|1440  Time for file to expire in minutes. Default is 5 minutes.
  -f, --file=file             The file to be shared.
  -m, --message=message       Add a message to accompany the file. Default is file name.

See code: src/commands/disposable/share.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
  --duplicate-from=duplicate-from  An Environment to duplicate from
  --file-path=file-path            A path to a JSON file

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 init

This commands creates an account, logs you in and creates an environment and sets up a project for you.

USAGE
  $ onboardbase init

See code: src/commands/init.ts

onboardbase integrations:railway

Railway Integration

USAGE
  $ onboardbase integrations:railway

See code: src/commands/integrations/railway.ts

onboardbase login

Authenticate your CLI

USAGE
  $ onboardbase login

OPTIONS
  --overwrite
  --password=password  Password

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
  -e, --environment=environment  Environment to recommend update for
  -h, --help                     show CLI help
  -n, --note=note                Note
  -p, --project=project          name of project
  --from-local-secrets           specify if you want to create a recommendation from your local secrets

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

onboardbase run [COMMAND]

Run a command with secrets injected into the environment

USAGE
  $ onboardbase run [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
  --accept-secret-sharing        A flag to accept secret sharing
  --live-reload                  Live Reload
  --password=password            Your Build Secure Password
  --secrets=secrets              A JSON string containing key/value pairs of your secrets
  --source-path=source-path      The source you would like to load your secrets from
  --sync                         Pull the latest secrets before starting the command.
  --verbose                      Enable warning/error logs

See code: src/commands/run.ts

onboardbase scan

Onboardbase Scan

USAGE
  $ onboardbase scan

See code: src/commands/scan.ts

onboardbase secrets [FORMAT]

Log secrets in different formats

USAGE
  $ onboardbase secrets [FORMAT]

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.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:download [FORMAT]

Download Secrets

USAGE
  $ onboardbase secrets:download [FORMAT]

OPTIONS
  -e, --environment=environment  Environment to run by default
  -h, --help                     show CLI help
  -p, --project=project          name of project
  --no-file                      No write to disk

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

onboardbase secrets:fetch [SECRET-KEY]

View a single secret value using its secret key

USAGE
  $ onboardbase secrets:fetch [SECRET-KEY]

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/fetch.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
  --secrets=secrets              Secrets to Upload

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

onboardbase setup

Setup the Onboardbase CLI for managing secrets

USAGE
  $ onboardbase setup

OPTIONS
  -e, --environment=environment  Environment to run by default
  -p, --project=project          name of project
  --start-script=start-script    Your project start command

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

onboardbase teammate

USAGE
  $ onboardbase teammate

OPTIONS
  -l, --signupLink=signupLink  (required) Link Sent to Email
  -n, --name=name              (required) Name of Teammate

See code: src/commands/teammate.ts

onboardbase tf [COMMAND]

Run a command with secrets injected into the environment

USAGE
  $ onboardbase tf [COMMAND]

OPTIONS
  -C, --command=command  Terraform command to execute
  -f, --file=file        Path to file
  -h, --help             show CLI help
  --enc-key=enc-key      Encryption Key

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

onboardbase tf:decrypt

Decrypt a TF state command back to how it was

USAGE
  $ onboardbase tf:decrypt

OPTIONS
  -f, --file=file    Path to file
  -h, --help         show CLI help
  --enc-key=enc-key  Encryption Key

See code: src/commands/tf/decrypt.ts

onboardbase tf:download

Downloads a state file to an Onboardbase store

USAGE
  $ onboardbase tf:download

OPTIONS
  -f, --file=file          Path to file
  -h, --help               show CLI help
  --file-id=file-id        A unique identifier for the file in the store
  --locker-key=locker-key  Locker Key
  --store-key=store-key    (required) Store Key

See code: src/commands/tf/download.ts

onboardbase tf:encrypt

Run a command with secrets injected into the environment

USAGE
  $ onboardbase tf:encrypt

OPTIONS
  -f, --file=file    Path to file
  -h, --help         show CLI help
  --enc-key=enc-key  Encryption Key

See code: src/commands/tf/encrypt.ts

onboardbase tf:upload

Uploads a state file to an Onboardbase store

USAGE
  $ onboardbase tf:upload

OPTIONS
  -f, --file=file          Path to file
  -h, --help               show CLI help
  --file-id=file-id        A unique identifier for the file in the store
  --locker-key=locker-key  Locker Key
  --store-key=store-key    (required) Store Key

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

onboardbase update

Update CLI to the latest version

USAGE
  $ onboardbase update

See code: src/commands/update.ts