conan editable¶

Allow working with a package that resides in user folder.

conan editable add¶

$ conan editable add -h
Migration: Successfully updated settings.yml
usage: conan editable add [-h] [-v [V]] [-cc CORE_CONF] [--name NAME]
                          [--version VERSION] [--user USER]
                          [--channel CHANNEL] [-of OUTPUT_FOLDER]
                          [-r REMOTE | -nr]
                          path

Define the given <path> location as the package <reference>, so when this
package is required, it is used from this <path> location instead of the
cache.

positional arguments:
  path                  Path to the package folder in the user workspace

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
                        Define core configuration, overwriting global.conf
                        values. E.g.: -cc core:non_interactive=True
  --name NAME           Provide a package name if not specified in conanfile
  --version VERSION     Provide a package version if not specified in
                        conanfile
  --user USER           Provide a user if not specified in conanfile
  --channel CHANNEL     Provide a channel if not specified in conanfile
  -of OUTPUT_FOLDER, --output-folder OUTPUT_FOLDER
                        The root output folder for generated and build files
  -r REMOTE, --remote REMOTE
                        Look in the specified remote or remotes server
  -nr, --no-remote      Do not use remote, resolve exclusively in the cache

conan editable remove¶

$ conan editable remove -h
WARN: Downgrading cache from Conan 2.6.0 to 2.5.0
usage: conan editable remove [-h] [-v [V]] [-cc CORE_CONF] [-r REFS] [path]

Remove the "editable" mode for this reference.

positional arguments:
  path                  Path to a folder containing a recipe (conanfile.py or
                        conanfile.txt) or to a recipe file. e.g.,
                        ./my_project/conanfile.txt.

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
                        Define core configuration, overwriting global.conf
                        values. E.g.: -cc core:non_interactive=True
  -r REFS, --refs REFS  Directly provide reference patterns

conan editable list¶

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

List all the packages in editable mode.

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
                        Define core configuration, overwriting global.conf
                        values. E.g.: -cc core:non_interactive=True