Enum Commands 

pub enum Commands {
    Auth(AuthNamespace),
    Project(Box<ProjectCommand>),
    Tool(ToolNamespace),
    Python(PythonNamespace),
    Pip(PipNamespace),
    Venv(VenvArgs),
    Build(BuildArgs),
    Publish(PublishArgs),
    Workspace(WorkspaceNamespace),
    BuildBackend {
        command: BuildBackendCommand,
    },
    Cache(CacheNamespace),
    Self_(SelfNamespace),
    Clean(CleanArgs),
    GenerateShellCompletion(GenerateShellCompletionArgs),
    Help(HelpArgs),
}

Variants

Auth(AuthNamespace)

Manage authentication.

Project(Box<ProjectCommand>)

Manage Python projects.

Tool(ToolNamespace)

Run and install commands provided by Python packages.

Python(PythonNamespace)

Manage Python versions and installations

Generally, uv first searches for Python in a virtual environment, either active or in a .venv directory in the current working directory or any parent directory. If a virtual environment is not required, uv will then search for a Python interpreter. Python interpreters are found by searching for Python executables in the PATH environment variable.

On Windows, the registry is also searched for Python executables.

By default, uv will download Python if a version cannot be found. This behavior can be disabled with the --no-python-downloads flag or the python-downloads setting.

The --python option allows requesting a different interpreter.

The following Python version request formats are supported:

• <version> e.g. 3, 3.12, 3.12.3
• <version-specifier> e.g. >=3.12,<3.13
• <version><short-variant> (e.g., 3.13t, 3.12.0d)
• <version>+<variant> (e.g., 3.13+freethreaded, 3.12.0+debug)
• <implementation> e.g. cpython or cp
• <implementation>@<version> e.g. cpython@3.12
• <implementation><version> e.g. cpython3.12 or cp312
• <implementation><version-specifier> e.g. cpython>=3.12,<3.13
• <implementation>-<version>-<os>-<arch>-<libc> e.g. cpython-3.12.3-macos-aarch64-none

Additionally, a specific system Python interpreter can often be requested with:

• <executable-path> e.g. /opt/homebrew/bin/python3
• <executable-name> e.g. mypython3
• <install-dir> e.g. /some/environment/

When the --python option is used, normal discovery rules apply but discovered interpreters are checked for compatibility with the request, e.g., if pypy is requested, uv will first check if the virtual environment contains a PyPy interpreter then check if each executable in the path is a PyPy interpreter.

uv supports discovering CPython, PyPy, and GraalPy interpreters. Unsupported interpreters will be skipped during discovery. If an unsupported interpreter implementation is requested, uv will exit with an error.

Pip(PipNamespace)

Manage Python packages with a pip-compatible interface.

Venv(VenvArgs)

Create a virtual environment.

By default, creates a virtual environment named .venv in the working directory. An alternative path may be provided positionally.

If in a project, the default environment name can be changed with the UV_PROJECT_ENVIRONMENT environment variable; this only applies when run from the project root directory.

If a virtual environment exists at the target path, it will be removed and a new, empty virtual environment will be created.

When using uv, the virtual environment does not need to be activated. uv will find a virtual environment (named .venv) in the working directory or any parent directories.

Build(BuildArgs)

Build Python packages into source distributions and wheels.

uv build accepts a path to a directory or source distribution, which defaults to the current working directory.

By default, if passed a directory, uv build will build a source distribution (“sdist”) from the source directory, and a binary distribution (“wheel”) from the source distribution.

uv build --sdist can be used to build only the source distribution, uv build --wheel can be used to build only the binary distribution, and uv build --sdist --wheel can be used to build both distributions from source.

If passed a source distribution, uv build --wheel will build a wheel from the source distribution.

Publish(PublishArgs)

Upload distributions to an index.

Workspace(WorkspaceNamespace)

Inspect uv workspaces.

BuildBackend

The implementation of the build backend.

These commands are not directly exposed to the user, instead users invoke their build frontend (PEP 517) which calls the Python shims which calls back into uv with this method.

Fields

command: BuildBackendCommand

Cache(CacheNamespace)

Manage uv’s cache.

Self_(SelfNamespace)

Manage the uv executable.

Clean(CleanArgs)

Clear the cache, removing all entries or those linked to specific packages.

GenerateShellCompletion(GenerateShellCompletionArgs)

Generate shell completion

Help(HelpArgs)

Display documentation for a command.

Trait Implementations

impl FromArgMatches for Commands

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Commands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand