CLI
settings instance¶
Every command (except the init) will require the Instance can be set using -i parameter or export INSTANCE_FOR_DYNACONF
The dynaconf CLI¶
The $ dynaconf -i config.settings cli provides some useful commands
IMPORTANT if you are using Flask Extension the env var
FLASK_APPmust be defined to use the CLI, and if using Django Extension theDJANGO_SETTINGS_MODULEmust be defined.
dynaconf --help¶
Usage: dynaconf [OPTIONS] COMMAND [ARGS]...
Dynaconf - Command Line Interface
Documentation: https://dynaconf.com/
Options:
--version Show dynaconf version
--docs Open documentation in browser
--banner Show awesome banner
-i, --instance TEXT Custom instance of LazySettings
--help Show this message and exit.
Commands:
get Returns the raw value for a settings key
init Inits a dynaconf project By default it creates a settings.toml...
list Lists all user defined config values and if `--all` is passed
it...
validate Validates Dynaconf settings based on rules defined in...
write Writes data to specific source
dynaconf init¶
Use init to easily configure your application configuration, once dynaconf is installed go to the root directory of your application and run:
$ dynaconf init -v key=value -v foo=bar -s token=1234
The above command will create in the current directory
settings.toml
KEY = "value"
FOO = "bar"
also .secrets.toml
TOKEN = "1234"
as well as .gitignore file ignoring the generated .secrets.toml
# Ignore dynaconf secret files
.secrets.*
For sensitive data in production is recommended using Vault Server
Usage: dynaconf init [OPTIONS]
Inits a dynaconf project By default it creates a settings.toml and a
.secrets.toml for [default|development|staging|testing|production|global]
envs.
The format of the files can be changed passing --format=yaml|json|ini|py.
This command must run on the project's root folder or you must pass
--path=/myproject/root/folder.
The --env/-e is deprecated (kept for compatibility but unused)
Options:
-f, --format [ini|toml|yaml|json|py|env]
-p, --path TEXT defaults to current directory
-e, --env TEXT Sets the working env in `.env` file
-v, --vars TEXT extra values to write to settings file e.g:
`dynaconf init -v NAME=foo -v X=2
-s, --secrets TEXT secret key values to be written in .secrets
e.g: `dynaconf init -s TOKEN=kdslmflds
--wg / --no-wg
-y
--django TEXT
--help Show this message and exit.
Note that -i/--instance cannot be used with init as -i must point to an existing instance of the settings.
Dynaconf get¶
Get raw value for a single key
Usage: dynaconf get [OPTIONS] KEY
Returns the raw value for a settings key
Options:
-d, --default TEXT Default value if settings doesn't exist
-e, --env TEXT Filters the env to get the values
-u, --unparse Unparse data by adding markers such as @none, @int etc..
--help Show this message and exit.
Example:
export FOO=$(dynaconf get DATABASE_NAME -d 'default')
dynaconf list¶
List all defined parameters and optionally export to a json file.
Usage: dynaconf list [OPTIONS]
Lists all user defined config values and if `--all` is passed it also
shows dynaconf internal variables.
Options:
-e, --env TEXT Filters the env to get the values
-k, --key TEXT Filters a single key
-m, --more Pagination more|less style
-l, --loader TEXT a loader identifier to filter e.g: toml|yaml
-a, --all show dynaconf internal settings?
-o, --output FILE Filepath to write the listed values as json
--output-flat Output file is flat (do not include [env] name)
--help Show this message and exit.
Exporting current environment as a file¶
dynaconf list -o path/to/file.yaml
The above command will export all the items showed by dynaconf list to the desired format which is inferred by the -o file extension, supported formats yaml, toml, ini, json, py
When using py you may want a flat output (without being nested inside the env key)
dynaconf list -o path/to/file.py --output-flat
dynaconf write¶
Usage: dynaconf write [OPTIONS] [ini|toml|yaml|json|py|redis|vault|env]
Writes data to specific source
Options:
-v, --vars TEXT key values to be written e.g: `dynaconf write toml -e
NAME=foo -e X=2
-s, --secrets TEXT secret key values to be written in .secrets e.g:
`dynaconf write toml -s TOKEN=kdslmflds -s X=2
-p, --path TEXT defaults to current directory/settings.{ext}
-e, --env TEXT env to write to defaults to DEVELOPMENT for files for
external sources like Redis and Vault it will be
DYNACONF or the value set in $ENVVAR_PREFIX_FOR_DYNACONF
-y
--help Show this message and exit.
dynaconf validate¶
NEW in 1.0.1
Starting on version 1.0.1 it is possible to define validators in TOML file called dynaconf_validators.toml placed in the same folder as your settings files.
dynaconf_validators.toml equivalent to program above
[default]
version = {must_exist=true}
name = {must_exist=true}
password = {must_exist=false}
[default.age]
must_exist = true
lte = 30
gte = 10
[production]
project = {eq="hello_world"}
Then to fire the validation use:
$ dynaconf -i config.settings validate
If validates it returns status 0 (success) and this command can be called in your CI/CD/Deploy jobs.
dynaconf --version¶
returns dynaconf version
$ dynaconf -i config.settings --version
1.0.0
dynaconf --docs¶
Opens Dynaconf documentation in browser
dynaconf --banner¶
Prints this awesome ascii made banner in the console :)
$ dynaconf -i config.settings --banner
██████╗ ██╗ ██╗███╗ ██╗ █████╗ ██████╗ ██████╗ ███╗ ██╗███████╗
██╔══██╗╚██╗ ██╔╝████╗ ██║██╔══██╗██╔════╝██╔═══██╗████╗ ██║██╔════╝
██║ ██║ ╚████╔╝ ██╔██╗ ██║███████║██║ ██║ ██║██╔██╗ ██║█████╗
██║ ██║ ╚██╔╝ ██║╚██╗██║██╔══██║██║ ██║ ██║██║╚██╗██║██╔══╝
██████╔╝ ██║ ██║ ╚████║██║ ██║╚██████╗╚██████╔╝██║ ╚████║██║
╚═════╝ ╚═╝ ╚═╝ ╚═══╝╚═╝ ╚═╝ ╚═════╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝
Learn more at: http://github.com/dynaconf/dynaconf