conan remote

Use this command to add, edit and remove Conan repositories from the Conan remote registry and also manage authentication to those remotes. For more information on how to work with Conan repositories, please check the dedicated section.

$ conan remote -h
WARN: Downgrading cache from Conan 2.3.1 to 2.2.3
usage: conan remote [-h] [-v [V]] [-cc CORE_CONF]
                    {add,auth,disable,enable,list,list-users,login,logout,remove,rename,set-user,update}
                    ...

Manage the remote list and the users authenticated on them.

positional arguments:
  {add,auth,disable,enable,list,list-users,login,logout,remove,rename,set-user,update}
                        sub-command help
    add                 Add a remote.
    auth                Authenticate in the defined remotes
    disable             Disable all the remotes matching a pattern.
    enable              Enable all the remotes matching a pattern.
    list                List current remotes.
    list-users          List the users logged into all the remotes.
    login               Login into the specified remotes matching a pattern.
    logout              Clear the existing credentials for the specified
                        remotes matching a pattern.
    remove              Remove remotes.
    rename              Rename a remote.
    set-user            Associate a username with a remote matching a pattern
                        without performing the authentication.
    update              Update a remote.

options:
  -h, --help            show this help message and exit
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan

conan remote add

$ conan remote add -h
Migration: Successfully updated settings.yml
Migration: Successfully updated cppstd_compat.py
usage: conan remote add [-h] [-v [V]] [-cc CORE_CONF] [--insecure]
                        [--index INDEX] [-f] [-ap ALLOWED_PACKAGES]
                        [-t {local-recipes-index}]
                        name url

Add a remote.

positional arguments:
  name                  Name of the remote to add
  url                   Url of the remote

options:
  -h, --help            show this help message and exit
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan
  --insecure            Allow insecure server connections when using SSL
  --index INDEX         Insert the remote at a specific position in the remote
                        list
  -f, --force           Force the definition of the remote even if duplicated
  -ap ALLOWED_PACKAGES, --allowed-packages ALLOWED_PACKAGES
                        Add recipe reference pattern to list of allowed
                        packages for this remote
  -t {local-recipes-index}, --type {local-recipes-index}
                        Define the remote type

conan remote auth

$ conan remote auth -h
Migration: Successfully updated settings.yml
Migration: Successfully updated cppstd_compat.py
usage: conan remote auth [-h] [-f FORMAT] [-v [V]] [-cc CORE_CONF]
                         [--with-user]
                         remote

Authenticate in the defined remotes

positional arguments:
  remote                Pattern or name of the remote/s to authenticate
                        against. The pattern uses 'fnmatch' style wildcards.

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan
  --with-user           Only try to auth in those remotes that already have a
                        username or a CONAN_LOGIN_ env-var defined

conan remote disable

$ conan remote disable -h
Migration: Successfully updated settings.yml
Migration: Successfully updated cppstd_compat.py
usage: conan remote disable [-h] [-f FORMAT] [-v [V]] [-cc CORE_CONF] remote

Disable all the remotes matching a pattern.

positional arguments:
  remote                Pattern of the remote/s to disable. The pattern uses
                        'fnmatch' style wildcards.

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan

conan remote enable

$ conan remote enable -h
Migration: Successfully updated settings.yml
Migration: Successfully updated cppstd_compat.py
usage: conan remote enable [-h] [-f FORMAT] [-v [V]] [-cc CORE_CONF] remote

Enable all the remotes matching a pattern.

positional arguments:
  remote                Pattern of the remote/s to enable. The pattern uses
                        'fnmatch' style wildcards.

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan

conan remote list

$ conan remote list -h
Migration: Successfully updated settings.yml
Migration: Successfully updated cppstd_compat.py
usage: conan remote list [-h] [-f FORMAT] [-v [V]] [-cc CORE_CONF]

List current remotes.

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan

conan remote list-users

$ conan remote list-users -h
WARN: Downgrading cache from Conan 2.3.1 to 2.2.3
usage: conan remote list-users [-h] [-f FORMAT] [-v [V]] [-cc CORE_CONF]

List the users logged into all the remotes.

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan

conan remote login

$ conan remote login -h
WARN: Downgrading cache from Conan 2.3.1 to 2.2.3
usage: conan remote login [-h] [-f FORMAT] [-v [V]] [-cc CORE_CONF]
                          [-p [PASSWORD]]
                          remote [username]

Login into the specified remotes matching a pattern.

positional arguments:
  remote                Pattern or name of the remote to login into. The
                        pattern uses 'fnmatch' style wildcards.
  username              Username

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan
  -p [PASSWORD], --password [PASSWORD]
                        User password. Use double quotes if password with
                        spacing, and escape quotes if existing. If empty, the
                        password is requested interactively (not exposed)

conan remote logout

$ conan remote logout -h
Migration: Successfully updated settings.yml
Migration: Successfully updated cppstd_compat.py
usage: conan remote logout [-h] [-f FORMAT] [-v [V]] [-cc CORE_CONF] remote

Clear the existing credentials for the specified remotes matching a pattern.

positional arguments:
  remote                Pattern or name of the remote to logout. The pattern
                        uses 'fnmatch' style wildcards.

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan

conan remote remove

$ conan remote remove -h
Migration: Successfully updated settings.yml
Migration: Successfully updated cppstd_compat.py
usage: conan remote remove [-h] [-v [V]] [-cc CORE_CONF] remote

Remove remotes.

positional arguments:
  remote                Name of the remote to remove. Accepts 'fnmatch' style
                        wildcards.

options:
  -h, --help            show this help message and exit
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan

conan remote rename

$ conan remote rename -h
WARN: Downgrading cache from Conan 2.3.1 to 2.2.3
usage: conan remote rename [-h] [-v [V]] [-cc CORE_CONF] remote new_name

Rename a remote.

positional arguments:
  remote                Current name of the remote
  new_name              New name for the remote

options:
  -h, --help            show this help message and exit
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan

conan remote set-user

$ conan remote set-user -h
WARN: Downgrading cache from Conan 2.3.1 to 2.2.3
usage: conan remote set-user [-h] [-f FORMAT] [-v [V]] [-cc CORE_CONF]
                             remote username

Associate a username with a remote matching a pattern without performing the
authentication.

positional arguments:
  remote                Pattern or name of the remote. The pattern uses
                        'fnmatch' style wildcards.
  username              Username

options:
  -h, --help            show this help message and exit
  -f FORMAT, --format FORMAT
                        Select the output format: json
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan

conan remote update

$ conan remote update -h
Migration: Successfully updated settings.yml
usage: conan remote update [-h] [-v [V]] [-cc CORE_CONF] [--url URL]
                           [--secure] [--insecure] [--index INDEX]
                           [-ap ALLOWED_PACKAGES]
                           remote

Update a remote.

positional arguments:
  remote                Name of the remote to update

options:
  -h, --help            show this help message and exit
  -v [V]                Level of detail of the output. Valid options from less
                        verbose to more verbose: -vquiet, -verror, -vwarning,
                        -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
                        -vvv or -vtrace
  -cc CORE_CONF, --core-conf CORE_CONF
                        Global configuration for Conan
  --url URL             New url for the remote
  --secure              Don't allow insecure server connections when using SSL
  --insecure            Allow insecure server connections when using SSL
  --index INDEX         Insert the remote at a specific position in the remote
                        list
  -ap ALLOWED_PACKAGES, --allowed-packages ALLOWED_PACKAGES
                        Add recipe reference pattern to the list of allowed
                        packages for this remote

See also

• Uploading packages tutorial

• Working with Conan repositories

• Upload Conan packages to remotes using conan upload command