@onboardbase/cli
Version:
[](https://www.npmjs.com/package/@onboardbase/cli) [](https://www.npmjs.com/package/@onboardbase/cli) [ • 16 kB
Markdown
# onboardbase-cli
[](https://www.npmjs.com/package/@onboardbase/cli)
[](https://www.npmjs.com/package/@onboardbase/cli)
[](https://github.com/Onboardbase/CLI/blob/master/package.json)
<!-- toc -->
* [onboardbase-cli](#onboardbase-cli)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @onboardbase/cli
$ onboardbase COMMAND
running command...
$ onboardbase (-v|--version|version)
@onboardbase/cli/8.10.0 linux-x64 node-v16.14.2
$ onboardbase --help [COMMAND]
USAGE
$ onboardbase COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`onboardbase auth [COMMAND]`](#onboardbase-auth-command)
* [`onboardbase build [COMMAND]`](#onboardbase-build-command)
* [`onboardbase config:get-token`](#onboardbase-configget-token)
* [`onboardbase config:set`](#onboardbase-configset)
* [`onboardbase destroy`](#onboardbase-destroy)
* [`onboardbase disposable:share [FILE]`](#onboardbase-disposableshare-file)
* [`onboardbase environment:create [SECRETS]`](#onboardbase-environmentcreate-secrets)
* [`onboardbase generateFigSpec`](#onboardbase-generatefigspec)
* [`onboardbase help [COMMAND]`](#onboardbase-help-command)
* [`onboardbase init`](#onboardbase-init)
* [`onboardbase integrations:railway`](#onboardbase-integrationsrailway)
* [`onboardbase login`](#onboardbase-login)
* [`onboardbase logout`](#onboardbase-logout)
* [`onboardbase mr:create [SECRETS]`](#onboardbase-mrcreate-secrets)
* [`onboardbase project:create`](#onboardbase-projectcreate)
* [`onboardbase run [COMMAND]`](#onboardbase-run-command)
* [`onboardbase scan`](#onboardbase-scan)
* [`onboardbase secrets [FORMAT]`](#onboardbase-secrets-format)
* [`onboardbase secrets:delete [SECRETS]`](#onboardbase-secretsdelete-secrets)
* [`onboardbase secrets:download [FORMAT]`](#onboardbase-secretsdownload-format)
* [`onboardbase secrets:fetch [SECRET-KEY]`](#onboardbase-secretsfetch-secret-key)
* [`onboardbase secrets:update [SECRETS]`](#onboardbase-secretsupdate-secrets)
* [`onboardbase secrets:upload [SECRETS]`](#onboardbase-secretsupload-secrets)
* [`onboardbase setup`](#onboardbase-setup)
* [`onboardbase share`](#onboardbase-share)
* [`onboardbase teammate`](#onboardbase-teammate)
* [`onboardbase tf [COMMAND]`](#onboardbase-tf-command)
* [`onboardbase tf:decrypt`](#onboardbase-tfdecrypt)
* [`onboardbase tf:download`](#onboardbase-tfdownload)
* [`onboardbase tf:encrypt`](#onboardbase-tfencrypt)
* [`onboardbase tf:upload`](#onboardbase-tfupload)
* [`onboardbase update`](#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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/src/commands/config/set.ts)_
## `onboardbase destroy`
cleanup Onboardbase artifacts including backup and authentication
```
USAGE
$ onboardbase destroy
```
_See code: [src/commands/destroy.ts](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/src/commands/disposable/share.ts)_
## `onboardbase environment:create [SECRETS]`
Create an environment under a project
```
USAGE
$ onboardbase environment:create [SECRETS]
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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/oclif/plugin-help/blob/v3.3.1/src/commands/help.ts)_
## `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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/src/commands/init.ts)_
## `onboardbase integrations:railway`
Railway Integration
```
USAGE
$ onboardbase integrations:railway
```
_See code: [src/commands/integrations/railway.ts](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/src/commands/integrations/railway.ts)_
## `onboardbase login`
Authenticate your CLI
```
USAGE
$ onboardbase login
OPTIONS
--overwrite
--password=password Password
```
_See code: [src/commands/login.ts](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/src/commands/login.ts)_
## `onboardbase logout`
Log out of the CLI
```
USAGE
$ onboardbase logout
```
_See code: [src/commands/logout.ts](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/src/commands/logout.ts)_
## `onboardbase mr:create [SECRETS]`
Create a recommendation
```
USAGE
$ onboardbase mr: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/mr/create.ts](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/src/commands/mr/create.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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/src/commands/project/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/src/commands/run.ts)_
## `onboardbase scan`
Onboardbase Scan
```
USAGE
$ onboardbase scan
```
_See code: [src/commands/scan.ts](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/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](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/src/commands/tf/upload.ts)_
## `onboardbase update`
Update CLI to the latest version
```
USAGE
$ onboardbase update
```
_See code: [src/commands/update.ts](https://github.com/Onboardbase/onboardbase-cli-ci/blob/v8.10.0/src/commands/update.ts)_
<!-- commandsstop -->