britive-cli
britive
What's New
-
britive checkout
command in interactive mode now correctly updates the ~/.aws/config file on Mac. -
listprofiles
command now displays the description in csv and json format.
Usage
$ npm install -g britive-cli
$ britive COMMAND
running command...
$ britive (-v|--version|version)
britive-cli/2.4.1 linux-x64 node-v10.24.1
$ britive --help [COMMAND]
USAGE
$ britive COMMAND
...
Commands
britive checkin [PROFILENAME]
britive checkout [PROFILENAME]
britive configure [CLOUDSERVICE]
britive listapplications [APPNAME]
britive listenvs [APPNAME]
britive listprofiles [APPENVNAME]
britive listsecrets [PATH]
britive login
britive logout
britive ls [LISTTYPE] [APPENVNAME]
britive user
britive viewsecret PATH
britive checkin [PROFILENAME]
Checks in a profile
USAGE
$ britive checkin [PROFILENAME]
ARGUMENTS
PROFILENAME Profile name for the environment to checkin
OPTIONS
-t, --token=token Specify the token used for token authentication with Britive CLI
--auth=token Must be specified with the -t option for token authentication with Britive CLI
--proxy=proxy Specify the proxy details for the checkout. You can also define your proxy using the conventional
"http_proxy" and "https_proxy" environment variables. Example: --proxy "http://127.0.0.1:8080".
britive checkout [PROFILENAME]
Checks out a profile
USAGE
$ britive checkout [PROFILENAME]
ARGUMENTS
PROFILENAME Name of the profile to be checked out
OPTIONS
-a, --alias=alias Specify an alias for profile being checked out. Defaults to profile name if not
specified
-b, --blocktime=blocktime Specify block time for polling, in minutes. Default value is 5 minutes for the
profiles that requires approval,
and 3 seconds for the profiles without approvals.
-c, --console Checkout only the console access for the profile
-h, --help Display help for checkout command
-j, --justification=justification Specify justification for the approval
-m, --mode=mode Specify mode for checkout : displaytext | displayjson | displayenv | integrate
-p, --maxpolltime=maxpolltime Specify maximum poll time, in minutes. Default value is 10 minutes
-r, --region=region Specify region for checkout (AWS only)
-s, --silent Specify silent mode
-t, --token=token Specify the token used for token authentication with Britive CLI
--auth=token Must be specified with the -t option for token authentication with Britive CLI
--cancel Withdraw the profile approval request.
--proxy=proxy Specify the proxy details for the checkout. You can also define your proxy using
the conventional "http_proxy" and "https_proxy" environment variables. Example:
--proxy "http://127.0.0.1:8080".
britive configure [CLOUDSERVICE]
Configures settings for Britive CLI
USAGE
$ britive configure [CLOUDSERVICE]
ARGUMENTS
CLOUDSERVICE aws
OPTIONS
-a, --account_number=yes|no Configures using AWS account numbers instead of AWS account names (AWS only)
-h, --help Display help for configure command
-o, --option=option Configures output format used by Britive CLI: (Table/Json/Csv)
-r, --region=region Configures region for AWS (AWS only)
-t, --tenant_domain=tenant_domain Configures the tenant domain used by Britive CLI
-u, --update=update Update configurations. Usage: -u/--update [section:]<name>=<value>
--aws AWS flag for configuring profile settings
--proxy=proxy Specify the proxy details for the checkout. You can also define your proxy using
the conventional "http_proxy" and "https_proxy" environment variables. Example:
--proxy "http://127.0.0.1:8080".
britive listapplications [APPNAME]
Lists applications assigned to the logged in identity
USAGE
$ britive listapplications [APPNAME]
ARGUMENTS
APPNAME Application Name
OPTIONS
-f, --format=format Specify display format: (Table/Json/Csv)
-h, --help Display help for listapplications command
-t, --token=token Specify the token used for token authentication with Britive CLI
--auth=token Must be specified with the -t option for token authentication with Britive CLI
--proxy=proxy Specify the proxy details for the checkout. You can also define your proxy using the conventional
"http_proxy" and "https_proxy" environment variables. Example: --proxy "http://127.0.0.1:8080".
ALIASES
$ britive --listapplications
britive listenvs [APPNAME]
Lists environments assigned to the logged in identity
USAGE
$ britive listenvs [APPNAME]
ARGUMENTS
APPNAME App Name
OPTIONS
-f, --format=format Specify display format: (Table/Json/Csv)
-h, --help Display help for listenvs command
-t, --token=token Specify the token used for token authentication with Britive CLI
--auth=token Must be specified with the -t option for token authentication with Britive CLI
--proxy=proxy Specify the proxy details for the checkout. You can also define your proxy using the conventional
"http_proxy" and "https_proxy" environment variables. Example: --proxy "http://127.0.0.1:8080".
britive listprofiles [APPENVNAME]
Lists profiles assigned to the logged in identity
USAGE
$ britive listprofiles [APPENVNAME]
ARGUMENTS
APPENVNAME "Application Name" or "Application Name/Environment Name" or "Application Name/Environment Name/Profile
Name"
OPTIONS
-c, --checkout Checked out profile
-f, --format=format Specify display format: (Table/Json/Csv)
-h, --help Display help for listprofiles command
-t, --token=token Specify the token used for token authentication with Britive CLI
--auth=token Must be specified with the -t option for token authentication with Britive CLI
--proxy=proxy Specify the proxy details for the checkout. You can also define your proxy using the conventional
"http_proxy" and "https_proxy" environment variables. Example: --proxy "http://127.0.0.1:8080".
britive listsecrets [PATH]
Lists secrets of the logged-in identity
USAGE
$ britive listsecrets [PATH]
ARGUMENTS
PATH Specify path to the Node(folder)
OPTIONS
-f, --format=format Specify display format: (Table/Json/Csv)
-h, --help Display help for listsecrets command
-l, --limit=limit Specify the limit for the number of secrets to be listed.
This option is applicable only for JSON/CSV output format
-s, --search=search Provide the search string to filter the secrets list
-t, --token=token Specify the token used for token authentication with Britive CLI
--auth=token Must be specified with the -t option for token authentication with Britive CLI
--proxy=proxy Specify the proxy details for the checkout. You can also define your proxy using the conventional
"http_proxy" and "https_proxy" environment variables. Example: --proxy "http://127.0.0.1:8080".
britive login
Used for interactive Login
USAGE
$ britive login
OPTIONS
--proxy=proxy Specify the proxy details for the checkout. You can also define your proxy using the conventional
"http_proxy" and "https_proxy" environment variables. Example: --proxy "http://127.0.0.1:8080".
britive logout
Logout the currently logged in user (only for interactive login)
USAGE
$ britive logout
OPTIONS
--proxy=proxy Specify the proxy details for the checkout. You can also define your proxy using the conventional
"http_proxy" and "https_proxy" environment variables. Example: --proxy "http://127.0.0.1:8080".
britive ls [LISTTYPE] [APPENVNAME]
Lists applications, environments or profiles assigned to the logged in identity
USAGE
$ britive ls [LISTTYPE] [APPENVNAME]
ARGUMENTS
LISTTYPE Specify entity to be listed (applications, environments, profiles)
APPENVNAME Specify application name, environment name or profile
OPTIONS
-c, --checkedout Checked out profile
-f, --format=format Specify display format: (Table/Json/Csv)
-h, --help Display help for listprofiles command
-t, --token=token Specify the token used for token authentication with Britive CLI
--auth=token Must be specified with the -t option for token authentication with Britive CLI
--proxy=proxy Specify the proxy details for the checkout. You can also define your proxy using the conventional
"http_proxy" and "https_proxy" environment variables. Example: --proxy "http://127.0.0.1:8080".
ALIASES
$ britive --listapplications
britive user
Displays logged in user (only for interactive login)
USAGE
$ britive user
britive viewsecret PATH
Displays secret for the logged in identity
USAGE
$ britive viewsecret PATH
ARGUMENTS
PATH Specify path to the Secret
OPTIONS
-F, --file=file Specify the path for the secret file to be downloaded.
If provided '-', the secret file will be printed to the standard output.
-b, --blocktime=blocktime Specify block time for polling, in minutes. Default value is 5 minutes
-f, --format=format Specify display format: (Table/Json/Csv)
-h, --help Display help for viewsecret command
-j, --justification=justification Specify justification for the approval
-m, --maxpolltime=maxpolltime Specify maximum poll time, in minutes. Default value is 10 minutes
-s, --secretonly Specify, to display secret only
-t, --token=token Specify the token used for token authentication with Britive CLI
--auth=token Must be specified with the -t option for token authentication with Britive CLI
--proxy=proxy Specify the proxy details for the checkout. You can also define your proxy using
the conventional "http_proxy" and "https_proxy" environment variables. Example:
--proxy "http://127.0.0.1:8080".