LinuxCommandLibrary

conda-rename

Rename a Conda environment

TLDR

Rename an environment via its name

$ conda rename [[-n|--name]] [current_name] [new_name]
copy

Rename an environment via its full path (i.e. prefix)
$ conda rename [[-p|--prefix]] [path/to/env] [new_name]
copy

SYNOPSIS

conda rename [options] <old_name> <new_name>

PARAMETERS

-h, --help
    Show help message and exit.

--dry-run
    Simulate rename; show actions without changes.

--force, -f
    Overwrite if target environment exists.

DESCRIPTION

conda-rename is a third-party Conda plugin that adds a rename subcommand to easily rename existing virtual environments. Unlike core Conda, which lacks a native rename feature and requires workarounds like cloning (conda create --clone) followed by deletion, conda-rename performs the operation efficiently by moving the environment directory and updating Conda's JSON metadata files. This preserves all packages, pip installs, and configurations without reinstallation.

It supports both environment names and full paths, making it versatile for complex setups. Installed via pip install conda-rename or conda install -c conda-forge conda-rename, it integrates seamlessly as a Conda entry point. Ideal for developers managing multiple envs, it avoids disk space waste and downtime. Always verify with --dry-run first.

CAVEATS

Third-party tool; install separately. May conflict with active envs or non-standard locations. Test with --dry-run. Not officially supported by Conda.

INSTALLATION

pip install conda-rename
or
conda install -c conda-forge conda-rename

EXAMPLE USAGE

conda rename oldenv newenv
conda rename --dry-run --force old new

HISTORY

Developed by Ilya Korobkov; first PyPI release in 2020. Gained popularity on conda-forge for filling Conda gap. Updated for Conda 4.10+ compatibility.

SEE ALSO

conda(1), mv(1)

Copied to clipboard