@bb-cli/bb-config

Get bb project or global options

Stats

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

Readme

NAME

bb-config - Get bb project or global options

SYNOPSIS

bb-config [--help] [-v|--version]
bb-config files [--help] [-f|--format <format>]
bb-config list [--help]

DESCRIPTION

To save multiple configurations for use with the bb-cli tools, configuration can be held in .bbconfig files.

When bb-cli commands are run the options are taken from the currently selected configuration.

OPTIONS

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

COMMANDS

NAME

bb-config files - List the BB CLI configuration files

SYNOPSIS

bb-config files [--help] [-f|--format <format>]

DESCRIPTION

The .bbconfig file is obtained by merging multiple configurations by this order of importance:

  • Local file: .bbconfig located in the current working directory - not parent directories
  • Global: .bbconfig file located in user’s home folder (~)

OPTIONS

Option Description
-f, --format <format> Output format (supported options: json)
--help Output usage information

EXAMPLES

List configuration files:

  $ bb-config files

NAME

bb-config list - List the BB CLI configuration data

SYNOPSIS

bb-config list [--help]

DESCRIPTION

This command will show you the current configuration data in JSON format.

The configuration is obtained by merging the global and local configuration files (see bb-config-files).

The configuration file is a JSON formatted file with root key names corresponding to profiles.

CLI commands sections can be added, and those options will only apply to those commands. Within a command section you can also add a sub-command section, and those options will only apply to the sub-commands.

EXAMPLE CONFIG

In this example, the command "bb-serve project" will load the port and plugins options. But the command "bb-serve foo" would only load the "port" option. Both commands would load the "portal-host" and "portal-port" properties.

{
  "default": {
    "portal-host": "my.portal.com",
    "portal-port": 80
  },
  "dev": {
    "portal-host": "192.168.99.100",
    "portal-port": 8080,
    "serve": {
      "port": 80,
      "project": {
        "plugins": "sass"
      }
     }
  }
}

NAMED PROFILES

The BB CLI supports named profiles stored in the config file. You can configure additional profiles by adding entries to the config file. By default all config values will be take from the 'default' profile.

To use a named profile set the BB_PROFILE environment variable at the command line.

EXAMPLES

List current configuration for default profile:

  $ bb-config list

List configuration for dev profile:

  $ BB_PROFILE=dev bb-config list

ENVIRONMENT VARIABLES

The profile which will be used by all CLIs when loading the config

BB_PROFILE=default

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.