UNPKG

@onboardbase/cli

Version:

[![Version](https://img.shields.io/npm/v/@onboardbase/cli.svg)](https://www.npmjs.com/package/@onboardbase/cli) [![Downloads/week](https://img.shields.io/npm/dw/@onboardbase/cli.svg)](https://www.npmjs.com/package/@onboardbase/cli) [![License](https://img

1 lines 15.4 kB
{"version":"8.10.0","commands":{"auth":{"id":"auth","description":"A one stop command for authenticating, setting up a project and running the project","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"command":{"name":"command","type":"option","char":"c","description":"Command to run","required":false},"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"overwrite":{"name":"overwrite","type":"boolean","required":false,"allowNo":false},"password":{"name":"password","type":"option","description":"Password"},"verbose":{"name":"verbose","type":"boolean","description":"Enable warning/error logs","allowNo":false}},"args":[{"name":"command"}]},"build":{"id":"build","description":"Run a command with secrets injected into the environment","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"project":{"name":"project","type":"option","char":"p","description":"name of project"},"environment":{"name":"environment","type":"option","char":"e","description":"Environment to run by default"},"command":{"name":"command","type":"option","char":"c","description":"Command to run","required":false},"prefix":{"name":"prefix","type":"option","char":"k","description":"Prefix","required":false},"passphrase":{"name":"passphrase","type":"option","char":"s","description":"Passphrase","required":false},"live-reload":{"name":"live-reload","type":"boolean","description":"Live Reload","required":false,"allowNo":false}},"args":[{"name":"command"}]},"destroy":{"id":"destroy","description":"cleanup Onboardbase artifacts including backup and authentication","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"init":{"id":"init","description":"This commands creates an account, logs you in and creates an environment and sets up a project for you.","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"login":{"id":"login","description":"Authenticate your CLI","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"overwrite":{"name":"overwrite","type":"boolean","required":false,"allowNo":false},"password":{"name":"password","type":"option","description":"Password"}},"args":[]},"logout":{"id":"logout","description":"Log out of the CLI","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"run":{"id":"run","description":"Run a command with secrets injected into the environment","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"project":{"name":"project","type":"option","char":"p","description":"name of project"},"environment":{"name":"environment","type":"option","char":"e","description":"Environment to run by default"},"command":{"name":"command","type":"option","char":"c","description":"Command to run","required":false},"password":{"name":"password","type":"option","description":"Your Build Secure Password"},"source-path":{"name":"source-path","type":"option","description":"The source you would like to load your secrets from","required":false},"sync":{"name":"sync","type":"boolean","description":"Pull the latest secrets before starting the command.","required":false,"allowNo":false},"secrets":{"name":"secrets","type":"option","description":"A JSON string containing key/value pairs of your secrets","required":false},"prefix":{"name":"prefix","type":"option","char":"k","description":"Prefix","required":false},"passphrase":{"name":"passphrase","type":"option","char":"s","description":"Passphrase","required":false},"live-reload":{"name":"live-reload","type":"boolean","description":"Live Reload","required":false,"allowNo":false},"accept-secret-sharing":{"name":"accept-secret-sharing","type":"boolean","description":"A flag to accept secret sharing","required":false,"allowNo":false},"verbose":{"name":"verbose","type":"boolean","description":"Enable warning/error logs","allowNo":false}},"args":[{"name":"command"}]},"scan":{"id":"scan","description":"Onboardbase Scan","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"secrets":{"id":"secrets","description":"Log secrets in different formats","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"project":{"name":"project","type":"option","char":"p","description":"name of project"},"environment":{"name":"environment","type":"option","char":"e","description":"Environment to run by default"}},"args":[{"name":"format"}]},"setup":{"id":"setup","description":"Setup the Onboardbase CLI for managing secrets","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"name of project"},"environment":{"name":"environment","type":"option","char":"e","description":"Environment to run by default"},"start-script":{"name":"start-script","type":"option","description":"Your project start command","required":false}},"args":[]},"share":{"id":"share","description":"Share your local .onboardbase.yaml secrets with a teammate","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"project":{"name":"project","type":"option","char":"p","description":"Project name"}},"args":[]},"teammate":{"id":"teammate","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"signupLink":{"name":"signupLink","type":"option","char":"l","description":"Link Sent to Email","required":true},"name":{"name":"name","type":"option","char":"n","description":"Name of Teammate","required":true}},"args":[]},"update":{"id":"update","description":"Update CLI to the latest version","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"config:get-token":{"id":"config:get-token","description":"Get all tokens","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"scope":{"name":"scope","type":"option","char":"S","description":"scope"}},"args":[]},"config:set":{"id":"config:set","description":"Update your onboardbase config","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"scope":{"name":"scope","type":"option","char":"s","description":"scope"},"token":{"name":"token","type":"option","char":"t","description":"Auth Token"},"api-host":{"name":"api-host","type":"option","char":"A","description":"API Host"},"dashboard-host":{"name":"dashboard-host","type":"option","char":"D","description":"Dashboard Host"},"password":{"name":"password","type":"option","description":"Password"},"re-authenticate":{"name":"re-authenticate","type":"boolean","allowNo":false}},"args":[]},"disposable:share":{"id":"disposable:share","description":"Share sensitive files securely and quickly with end-to-end encryption and automatic deletion","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"file":{"name":"file","type":"option","char":"f","description":"The file to be shared."},"expires":{"name":"expires","type":"option","char":"e","description":"Time for file to expire in minutes. Default is 5 minutes.","options":["5","30","60","1440"]},"message":{"name":"message","type":"option","char":"m","description":"Add a message to accompany the file. Default is file name."}},"args":[{"name":"file"}]},"environment:create":{"id":"environment:create","description":"Create an environment under a project","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"project":{"name":"project","type":"option","char":"p","description":"name of project","required":false},"environment":{"name":"environment","type":"option","char":"e","description":"Environment Title","required":true},"file-path":{"name":"file-path","type":"option","description":"A path to a JSON file"},"duplicate-from":{"name":"duplicate-from","type":"option","description":"An Environment to duplicate from"}},"args":[{"name":"secrets"}]},"integrations:railway":{"id":"integrations:railway","description":"Railway Integration","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"mr:create":{"id":"mr:create","description":"Create a recommendation","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"project":{"name":"project","type":"option","char":"p","description":"name of project","required":false},"environment":{"name":"environment","type":"option","char":"e","description":"Environment to recommend update for"},"note":{"name":"note","type":"option","char":"n","description":"Note","required":false},"from-local-secrets":{"name":"from-local-secrets","type":"boolean","description":"specify if you want to create a recommendation from your local secrets","allowNo":false}},"args":[{"name":"secrets"}]},"project:create":{"id":"project:create","description":"Create a project","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"title":{"name":"title","type":"option","char":"t","description":"name of project"},"description":{"name":"description","type":"option","char":"d","description":"Project description"},"environment":{"name":"environment","type":"option","char":"e","description":"Environment to run by default","required":false}},"args":[]},"secrets:delete":{"id":"secrets:delete","description":"Update secrets on Onboardbase","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"project":{"name":"project","type":"option","char":"p","description":"name of project"},"environment":{"name":"environment","type":"option","char":"e","description":"Environment to run by default"}},"args":[{"name":"secrets"}]},"secrets:download":{"id":"secrets:download","description":"Download Secrets","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"project":{"name":"project","type":"option","char":"p","description":"name of project"},"environment":{"name":"environment","type":"option","char":"e","description":"Environment to run by default"},"no-file":{"name":"no-file","type":"boolean","description":"No write to disk","required":false,"allowNo":false}},"args":[{"name":"format"}]},"secrets:fetch":{"id":"secrets:fetch","description":"View a single secret value using its secret key","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"project":{"name":"project","type":"option","char":"p","description":"name of project"},"environment":{"name":"environment","type":"option","char":"e","description":"Environment to run by default"}},"args":[{"name":"secret-key"}]},"secrets:update":{"id":"secrets:update","description":"Update secrets on Onboardbase","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"project":{"name":"project","type":"option","char":"p","description":"name of project"},"environment":{"name":"environment","type":"option","char":"e","description":"Environment to run by default"}},"args":[{"name":"secrets"}]},"secrets:upload":{"id":"secrets:upload","description":"Upload secrets","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"project":{"name":"project","type":"option","char":"p","description":"name of project"},"environment":{"name":"environment","type":"option","char":"e","description":"Environment to run by default"},"secrets":{"name":"secrets","type":"option","description":"Secrets to Upload"}},"args":[{"name":"secrets"}]},"tf:decrypt":{"id":"tf:decrypt","description":"Decrypt a TF state command back to how it was","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"enc-key":{"name":"enc-key","type":"option","description":"Encryption Key","required":false},"file":{"name":"file","type":"option","char":"f","description":"Path to file","required":false}},"args":[]},"tf:download":{"id":"tf:download","description":"Downloads a state file to an Onboardbase store","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"store-key":{"name":"store-key","type":"option","description":"Store Key","required":true},"locker-key":{"name":"locker-key","type":"option","description":"Locker Key","required":false},"file":{"name":"file","type":"option","char":"f","description":"Path to file","required":false},"file-id":{"name":"file-id","type":"option","description":"A unique identifier for the file in the store","required":false}},"args":[]},"tf:encrypt":{"id":"tf:encrypt","description":"Run a command with secrets injected into the environment","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"enc-key":{"name":"enc-key","type":"option","description":"Encryption Key","required":false},"file":{"name":"file","type":"option","char":"f","description":"Path to file","required":false}},"args":[]},"tf":{"id":"tf","description":"Run a command with secrets injected into the environment","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"command":{"name":"command","type":"option","char":"C","description":"Terraform command to execute"},"file":{"name":"file","type":"option","char":"f","description":"Path to file","required":false},"enc-key":{"name":"enc-key","type":"option","description":"Encryption Key","required":false}},"args":[{"name":"command"}]},"tf:upload":{"id":"tf:upload","description":"Uploads a state file to an Onboardbase store","pluginName":"@onboardbase/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"store-key":{"name":"store-key","type":"option","description":"Store Key","required":true},"locker-key":{"name":"locker-key","type":"option","description":"Locker Key","required":false},"file-id":{"name":"file-id","type":"option","description":"A unique identifier for the file in the store","required":false},"file":{"name":"file","type":"option","char":"f","description":"Path to file","required":false}},"args":[]}}}