britive-cli

britive-cli ===========

Usage no npm install needed!

<script type="module">
  import britiveCli from 'https://cdn.skypack.dev/britive-cli';
</script>

README

britive-cli

britive

oclif Version Downloads/week License

What's New

Added Support for the following functionality:

  • JSON and CSV output formats for listing profiles, applications, and environments (Run the britive configure command to configure output formats)
  • Display the current logged-in user
  • Display list of checked-out profiles
  • Addition of session expiration time in the AWS .credentials file
  • Exit codes of “0” and “1” indicating success or failure in CLI command execution.
  • Logout command for logging out the current user.
  • Check-in feature for checked-out profiles.
  • ls is a consolidated command for listing applications, environments, and profiles
  • Configuration of AWS Region during britive configure aws.
  • Account number configuration for AWS profile name or id checkout, with britive configure aws.
  • AWS sourcing credentials with an external process.
  • Support token-based authentication for the CLI.
  • New environment name column available in listing profiles.
  • Support for GCP and Azure services for check-out, check-in, and listing profiles.

Usage

$ npm install -g britive-cli
$ britive COMMAND
running command...
$ britive (-v|--version|version)
britive-cli/1.2.3 linux-x64 node-v14.15.0
$ britive --help [COMMAND]
USAGE
  $ britive COMMAND
...

Commands

britive checkin [PROFILENAME]

checkin profile

USAGE
  $ britive checkin [PROFILENAME]

ARGUMENTS
  PROFILENAME  Profile name for the environment to checkin

OPTIONS
  -t, --token=token  Token
  --auth=token       Auth method

britive checkout [PROFILENAME]

checkout the Profle based on checkout mode

USAGE
  $ britive checkout [PROFILENAME]

ARGUMENTS
  PROFILENAME  Profile name for the environment to be checked out

OPTIONS
  -a, --alias=alias    alias for checked out profile
  -h, --help           show CLI help
  -m, --mode=mode      displaytext | displayjson | displayenv | integrate
  -r, --region=region  Check region flag during manual checkout
  -s, --silent         Check silent flag used during credential helper
  -t, --token=token    Token
  --auth=token         Auth method

britive configure [CLOUDSERVICE]

configure settings for Britive CLI

USAGE
  $ britive configure [CLOUDSERVICE]

ARGUMENTS
  CLOUDSERVICE  aws | azure | gcp

OPTIONS
  -a, --account_number=yes|no        AWS account number settings
  -h, --help                         show CLI help
  -o, --option=option                Define output format
  -r, --region=region                AWS region configuration
  -t, --tenant_domain=tenant_domain  Enter Tenant Domain
  --aws                              AWS flag for configuring profile settings

britive help [COMMAND]

display help for britive

USAGE
  $ britive help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

britive listapplications

list all applications for the account

USAGE
  $ britive listapplications

OPTIONS
  -f, --format=format  Display options
  -h, --help           show CLI help
  -t, --token=token    Token
  --auth=token         Auth method

ALIASES
  $ britive --listapplications

britive listenvs [APPNAME]

list all environment for the account

USAGE
  $ britive listenvs [APPNAME]

ARGUMENTS
  APPNAME  App Name

OPTIONS
  -f, --format=format  Display options
  -h, --help           show CLI help
  -t, --token=token    Token
  --auth=token         Auth method

britive listprofiles [APPENVNAME]

list all profiles for the account

USAGE
  $ britive listprofiles [APPENVNAME]

ARGUMENTS
  APPENVNAME  App and Environment Name with delimiter "/"

OPTIONS
  -c, --checkout       Checked out profile
  -f, --format=format  Display options
  -h, --help           show CLI help
  -t, --token=token    Token
  --auth=token         Auth method

britive login

Login via browser

USAGE
  $ britive login

britive logout

Logout

USAGE
  $ britive logout

britive ls [LISTTYPE] [APPENVNAME]

list profiles | applications | environments for the account

USAGE
  $ britive ls [LISTTYPE] [APPENVNAME]

ARGUMENTS
  LISTTYPE    List type profiles | applications | environments
  APPENVNAME  App and Environment Name with delimiter "/" --> optional parameter

OPTIONS
  -c, --checkedout     Checked out profile
  -f, --format=format  Display options
  -h, --help           show CLI help
  -t, --token=token    Token
  --auth=token         Auth method

ALIASES
  $ britive --listapplications

britive user

display current user

USAGE
  $ britive user