Skip to content

CLI Overview

Jeff Felchner edited this page Mar 6, 2023 · 2 revisions

Chamber provides a flexible binary that you can use to make working with your configurations easier. Let's take a look:

Common Options

Each of the commands described below takes a few common options.

Option Alt Description
--preset -p Allows you to quickly set the basepath, files and/or namespaces for a given situation (eg working with a Rails app).

Example: --preset=rails
--rootpath -r Allows you to quickly set the rootpath of the application. By default this is the directory that the chamber executable is run from.

Example: --rootpath=/path/to/my/application
--basepath -b Sets the base path that Chamber will use to look for its common settings files.

Example: --basepath=/path/to/my/application
--files -f Allows you to specifically set the file patterns that Chamber should look at in determining where to load settings information from.

Example: --files=/path/to/my/application/secret.yml /path/to/my/application/settings/*.yml
--namespaces -n The namespace values which will be considered for loading settings files.

Example: --namespaces=development tumbleweed
--encryption-keys The path to the key which will be used for encryption. This is optional unless you need to secure any settings.

Additionally you may pass in the actual contents of the key for this option.

Example: --encryption-keys=/path/to/my/app/my_project_rsa.pub
--decryption-keys The path to the key which will be used for decryption. This is optional unless you need to decrypt any settings.

Additionally you may pass in the actual contents of the key for this option.

Example: --decryption-keys=/path/to/my/app/my_project_rsa

Note: --basepath and --files are mutually exclusive. --files will always take precedence.

Less Common Options

Note: Only select commands support the following options. Use chamber help SUBCOMMAND to verify if a particular command does.

Option Alt Description
--dry-run -d The command will not actually execute, but will show you a summary of what would have happened.

Example: --dry-run
--only-secured -o This is the default. Because most systems have no issues reading from the config files you have stored in your repo, there is no need to process all of your settings. So by default, Chamber will only convert, push, etc those settings which have been gitignored or those which have been encrpyted.

To process everything, use the --skip-secure-only flag.

Example: --secure-only, --skip-secure-only
Clone this wiki locally