conan config

$ conan config [-h] {get,home,install,rm,set,init,list} ...

Manages Conan configuration.

Used to edit conan.conf, or install config files.

positional arguments:
  {get,home,install,rm,set,init,list}
                        sub-command help
    get                 Get the value of configuration item
    home                Retrieve the Conan home directory
    install             Install a full configuration from a local or remote
                        zip file
    rm                  Remove an existing config element
    set                 Set a value for a configuration item
    init                Initializes Conan configuration files
    list                List Conan configuration properties

optional arguments:
  -h, --help            show this help message and exit

Examples

Change the logging level to 10:
```
$ conan config set log.level=10
```
Get the logging level:
```
$ conan config get log.level
$> 10
```

Get the Conan home directory:

$ conan config home
$> /home/user/.conan

Create all missing configuration files:
```
$ conan config init
```
Delete the existing configuration files and create all configuration files:
```
$ conan config init --force
```
List all possible properties allowed for global.conf
```
$ conan config list
```

Set config install scheduler for every 1 week:

$ conan config set general.config_install_interval=1w

conan config install

usage: conan config install [-h] [--verify-ssl [VERIFY_SSL]] [--type {git}]
                            [--args ARGS] [-sf SOURCE_FOLDER] [-tf TARGET_FOLDER]
                            [-l] [-r REMOVE]
                            [item]

positional arguments:
  item                  git repository, local file or folder or zip file (local or
                        http) where the configuration is stored

optional arguments:
  -h, --help            show this help message and exit
  --verify-ssl [VERIFY_SSL]
                        Verify SSL connection when downloading file
  --type {git,dir,file,url}, -t {git,dir,file,url}
                        Type of remote config
  --args ARGS, -a ARGS  String with extra arguments for "git clone"
  -sf SOURCE_FOLDER, --source-folder SOURCE_FOLDER
                        Install files only from a source subfolder from the
                        specified origin
  -tf TARGET_FOLDER, --target-folder TARGET_FOLDER
                        Install to that path in the conan cache
  -l, --list            List stored configuration origins
  -r REMOVE, --remove REMOVE
                        Remove configuration origin by index in list (index provided by --list argument)

The config install is intended to share the Conan client configuration. For example, in a company or organization, is important to have common settings.yml, profiles, etc.

It can install one specific file or get its configuration files from a local or remote zip file, from a local directory or from a git repository. It then installs the files in the local Conan configuration.

The configuration may contain all or a subset of the allowed configuration files. Only the files that are present will be replaced. The only exception is the conan.conf file for which only the variables declared will be installed, leaving the other variables unchanged.

This means for example that profiles and hooks files will be overwritten if already present, but no profile or hook file that the user has in the local machine will be deleted.

All the configuration files will be copied to the Conan home directory. These are the special files and the rules applied to merge them:

File	How it is applied
profiles/MyProfile	Overrides the local ~/.conan/profiles/MyProfile if already exists
settings.yml	Overrides the local ~/.conan/settings.yml
remotes.txt	Overrides remotes. Will remove remotes that are not present in file
remotes.json (Since 1.52)	Overrides remotes. Will remove remotes that are not present in file. Please, note that only one of remotes.json or remotes.txt should be installed. If you have both .txt and .json in the folder, repo, etc. that you are installing from, it can lead to undefined behaviour as the order of the install is not deterministic
config/conan.conf	Merges the variables, overriding only the declared variables
hooks/my_hook.py	Overrides the local ~/.conan/hooks/my_hook.py if already exists

The file remotes.txt is the only file listed above which does not have a direct counterpart in the ~/.conan folder. Its format is a list of entries, one on each line, with the form of

[remote name] [remote url] [bool]

where [bool] (either True or False) indicates whether SSL should be used to verify that remote. The remote definitions can be found in the remotes.json file and it provides a helpful starting point when writing the remotes.txt to be packaged in a Conan client configuration.

Note

During the installation, Conan skips any file with the name README.md or LICENSE.txt.

The conan config install <item> calls are stored in a config_install.json file in the Conan local cache. That allows to issue a conan config install command, without arguments, to iterate over the cached configurations, executing them again (updating).

The conan config install can be periodically executed, before any command, when config_install_interval is configured in conan.conf. Conan runs it based on config_install.json, including the timestamp of the last change.

Examples:

Install the configuration from a URL:

$ conan config install http://url/to/some/config.zip

Install the configuration from a URL, but only getting the files inside a origin folder inside the zip file, and putting them inside a target folder in the local cache:
```
$ conan config install http://url/to/some/config.zip -sf=origin -tf=target
```

Install configuration from 2 different zip files from 2 different urls, using different source and target folders for each one, then update all:

$ conan config install http://url/to/some/config.zip -sf=origin -tf=target
$ conan config install http://url/to/some/config.zip -sf=origin2 -tf=target2
$ conan config install http://other/url/to/other.zip -sf=hooks -tf=hooks
# Later on, execute again the previous configurations cached:
$ conan config install

It’s not needed to specify any argument, it will iterate previously stored configurations in config_install.json, executing them again.

Install the configuration from a Git repository with submodules:

$ conan config install http://github.com/user/conan_config/.git --args "--recursive"

You can also force the git download by using --type git (in case it is not deduced from the URL automatically):

$ conan config install http://github.com/user/conan_config/.git --type git

Install from a URL skipping SSL verification:
```
$ conan config install http://url/to/some/config.zip --verify-ssl=False
```
This will disable the SSL check of the certificate.

Install a specific file from a local path:

$ conan config install my_settings\settings.yml

Install the configuration from a local path:

$ conan config install /path/to/some/config.zip

List all previously installed origins (the ones that will be used if conan config install is called without args):
```
$ conan config install --list
```

This will display the list of stored origins, with their index inside the list.

Remove one of the previously installed origins:
```
$ conan config install --remove=1
```

This will remove the element with index=1 (second element in the list) of the existing origins. This means that the next conan config install manual or scheduled calls to this command will not use this origin anymore.