@bb-cli/bb-import

Imports packages into a running Backbase portal using the REST API

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@bb-cli/bb-import
Minified + gzip package size for @bb-cli/bb-import in KB

Readme

NAME

bb-import - Imports packages into a running Backbase portal using the REST API

SYNOPSIS

bb-import [--help] [-v|--version]
bb-import package [--help] [--portal-protocol <protocol>] [--portal-host <host>]
    [--portal-port <port>] [--portal-context <context>] [--portal-version <version>]
    [--auth-type <ropc|basic>] [--portal-username <username>] [--portal-password <password>]
    [--portal-auth-path <path>] [--ropc-identity-provider <url>] [--ropc-client-id <id>]
    [--ropc-scope <scope>] [--ropc-client-secret <secret>] [--no-provisioning]
    [-f|--format <format>] <path>

OPTIONS

Option Description
-v, --version output the version number
--help Output usage information

EXAMPLES

  bb-import package.zip

COMMANDS

NAME

bb-import package - Imports provisioning packages to a running Backbase portal using REST API

SYNOPSIS

bb-import package [--help] [--portal-protocol <protocol>] [--portal-host <host>]
    [--portal-port <port>] [--portal-context <context>] [--portal-version <version>]
    [--auth-type <ropc|basic>] [--portal-username <username>] [--portal-password <password>]
    [--portal-auth-path <path>] [--ropc-identity-provider <url>] [--ropc-client-id <id>]
    [--ropc-scope <scope>] [--ropc-client-secret <secret>] [--no-provisioning]
    [-f|--format <format>] <path>

OPTIONS

Option Description
--portal-protocol <protocol> Protocol of the URL identifying Backbase server
--portal-host <host> Host name of the URL identifying Backbase server
--portal-port <port> Port of the URL identifying Backbase server
--portal-context <context> Application context of the Backbase server
--portal-version <version> Portal version (5, 6, 6.1)
--auth-type <ropc|basic> The type of authentication mechanism to use. The default is "basic" for legacy Backbase Authentication Services, using basic Auth. Use "ropc" for Backbase Identity and Access Management (or other compatible Identity Provider. See the online Backbase Documentation for more details.
--portal-username <username> Username
--portal-password <password> Password
--portal-auth-path <path> Authorization path (for basic auth only)
--ropc-identity-provider <url> Full URL of the identity provider for ROPC auth
--ropc-client-id <id> A unique string that was used when registering the CLI as a client
--ropc-scope <scope> The scope of the access request
--ropc-client-secret <secret> Usually optional, a secret/password assigned to the client in the Identity Provider config when the CLI was registered as a client
--no-provisioning Force use of package endpoint
-f, --format <format> Output format (supported options: json)
--help Output usage information

PROXY

This tool is using request library for HTTP requests.

The following environment variables are respected by request:

  • HTTP_PROXY / http_proxy
  • HTTPS_PROXY / https_proxy
  • NO_PROXY / no_proxy

When HTTP_PROXY / http_proxy are set, they will be used to proxy non-SSL requests that do not have an explicit proxy configuration option present. Similarly, HTTPS_PROXY / https_proxy will be respected for SSL requests that do not have an explicit proxy configuration option. It is valid to define a proxy in one of the environment variables, but then override it for a specific request, using the proxy configuration option. Furthermore, the proxy configuration option can be explicitly set to false / null to opt out of proxying altogether for that request.

request is also aware of the NO_PROXY/no_proxy environment variables. These variables provide a granular way to opt out of proxying, on a per-host basis. It should contain a comma separated list of hosts to opt out of proxying. It is also possible to opt of proxying when a particular destination port is used. Finally, the variable may be set to * to opt out of the implicit proxy configuration of the other environment variables.

Here's some examples of valid no_proxy values:

  • example.com - don't proxy HTTP/HTTPS requests to example.com
  • example.com:443 - don't proxy HTTPS requests to example.com, but do proxy HTTP requests to example.com
  • example.com:443, backbase.com:80 - don't proxy HTTPS requests to example.com, and don't proxy HTTP requests to backbase.com
      • ignore https_proxy/http_proxy environment variables altogether.

EXAMPLES

Backbase 5.6.x

  $ bb-import package package.zip
  $ bb-import package package.zip --portal-port 8080

Backbase 6.0.x

  $ bb-import package provision.zip --portal-host xxx.backbase.dev --portal-port 8080 --portal-version 6

Backbase 6.1.x

  $ bb-import package provision.zip --portal-host xxx.backbase.dev --portal-port 8080 --portal-version 6.1

ENVIRONMENT VARIABLES

Set the amount of log output

LOG_LEVEL=silly|verbose|info|warn|error

Set whether or not to use colors in output

COLOR=false|true

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.