diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index b3862fee6..2ca2f733d 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -213,19 +213,19 @@ impl From for anstream::ColorChoice { #[derive(Subcommand)] #[allow(clippy::large_enum_variant)] pub enum Commands { - /// Resolve and install Python packages. + /// Manage Python packages with a pip-compatible interface. #[command( after_help = "Use `uv help pip`` for more details.", after_long_help = "" )] Pip(PipNamespace), - /// Run and manage executable Python packages. + /// Run and manage tools provided by Python packages (experimental). #[command( after_help = "Use `uv help tool` for more details.", after_long_help = "" )] Tool(ToolNamespace), - /// Manage Python installations. + /// Manage Python versions and installations (experimental). #[command( after_help = "Use `uv help python` for more details.", after_long_help = "" @@ -415,39 +415,39 @@ pub enum PipCommand { #[derive(Subcommand)] pub enum ProjectCommand { - /// Initialize a project. + /// Create a new project (experimental). Init(InitArgs), - /// Run a command in the project environment. + /// Run a command in an environment (experimental). #[command( after_help = "Use `uv help run` for more details.", after_long_help = "" )] Run(RunArgs), - /// Sync the project's dependencies with the environment. + /// Update the project's environment to match the project's dependencies (experimental). #[command( after_help = "Use `uv help sync` for more details.", after_long_help = "" )] Sync(SyncArgs), - /// Resolve the project requirements into a lockfile. + /// Create or update a lockfile for the project's dependencies (experimental). #[command( after_help = "Use `uv help lock` for more details.", after_long_help = "" )] Lock(LockArgs), - /// Add one or more packages to the project requirements. + /// Add one or more packages to the project's dependencies (experimental). #[command( after_help = "Use `uv help add` for more details.", after_long_help = "" )] Add(AddArgs), - /// Remove one or more packages from the project requirements. + /// Remove one or more packages from the project's dependencies (experimental). #[command( after_help = "Use `uv help remove` for more details.", after_long_help = "" )] Remove(RemoveArgs), - /// Display the dependency tree for the project. + /// Display the dependency tree for the project (experimental). Tree(TreeArgs), } diff --git a/crates/uv/tests/help.rs b/crates/uv/tests/help.rs index 3c74f6627..dc92bf57d 100644 --- a/crates/uv/tests/help.rs +++ b/crates/uv/tests/help.rs @@ -16,16 +16,16 @@ fn help() { Usage: uv [OPTIONS] Commands: - pip Resolve and install Python packages - tool Run and manage executable Python packages - python Manage Python installations - init Initialize a project - run Run a command in the project environment - sync Sync the project's dependencies with the environment - lock Resolve the project requirements into a lockfile - add Add one or more packages to the project requirements - remove Remove one or more packages from the project requirements - tree Display the dependency tree for the project + pip Manage Python packages with a pip-compatible interface + tool Run and manage tools provided by Python packages (experimental) + python Manage Python versions and installations (experimental) + init Create a new project (experimental) + run Run a command in an environment (experimental) + sync Update the project's environment to match the project's dependencies (experimental) + lock Create or update a lockfile for the project's dependencies (experimental) + add Add one or more packages to the project's dependencies (experimental) + remove Remove one or more packages from the project's dependencies (experimental) + tree Display the dependency tree for the project (experimental) venv Create a virtual environment cache Manage the cache version Display uv's version @@ -82,16 +82,16 @@ fn help_flag() { Usage: uv [OPTIONS] Commands: - pip Resolve and install Python packages - tool Run and manage executable Python packages - python Manage Python installations - init Initialize a project - run Run a command in the project environment - sync Sync the project's dependencies with the environment - lock Resolve the project requirements into a lockfile - add Add one or more packages to the project requirements - remove Remove one or more packages from the project requirements - tree Display the dependency tree for the project + pip Manage Python packages with a pip-compatible interface + tool Run and manage tools provided by Python packages (experimental) + python Manage Python versions and installations (experimental) + init Create a new project (experimental) + run Run a command in an environment (experimental) + sync Update the project's environment to match the project's dependencies (experimental) + lock Create or update a lockfile for the project's dependencies (experimental) + add Add one or more packages to the project's dependencies (experimental) + remove Remove one or more packages from the project's dependencies (experimental) + tree Display the dependency tree for the project (experimental) venv Create a virtual environment cache Manage the cache version Display uv's version @@ -147,16 +147,16 @@ fn help_short_flag() { Usage: uv [OPTIONS] Commands: - pip Resolve and install Python packages - tool Run and manage executable Python packages - python Manage Python installations - init Initialize a project - run Run a command in the project environment - sync Sync the project's dependencies with the environment - lock Resolve the project requirements into a lockfile - add Add one or more packages to the project requirements - remove Remove one or more packages from the project requirements - tree Display the dependency tree for the project + pip Manage Python packages with a pip-compatible interface + tool Run and manage tools provided by Python packages (experimental) + python Manage Python versions and installations (experimental) + init Create a new project (experimental) + run Run a command in an environment (experimental) + sync Update the project's environment to match the project's dependencies (experimental) + lock Create or update a lockfile for the project's dependencies (experimental) + add Add one or more packages to the project's dependencies (experimental) + remove Remove one or more packages from the project's dependencies (experimental) + tree Display the dependency tree for the project (experimental) venv Create a virtual environment cache Manage the cache version Display uv's version @@ -208,7 +208,7 @@ fn help_subcommand() { success: true exit_code: 0 ----- stdout ----- - Manage Python installations + Manage Python versions and installations (experimental) Usage: uv python [OPTIONS] @@ -450,7 +450,7 @@ fn help_flag_subcommand() { success: true exit_code: 0 ----- stdout ----- - Manage Python installations + Manage Python versions and installations (experimental) Usage: uv python [OPTIONS] @@ -636,16 +636,16 @@ fn help_with_global_option() { Usage: uv [OPTIONS] Commands: - pip Resolve and install Python packages - tool Run and manage executable Python packages - python Manage Python installations - init Initialize a project - run Run a command in the project environment - sync Sync the project's dependencies with the environment - lock Resolve the project requirements into a lockfile - add Add one or more packages to the project requirements - remove Remove one or more packages from the project requirements - tree Display the dependency tree for the project + pip Manage Python packages with a pip-compatible interface + tool Run and manage tools provided by Python packages (experimental) + python Manage Python versions and installations (experimental) + init Create a new project (experimental) + run Run a command in an environment (experimental) + sync Update the project's environment to match the project's dependencies (experimental) + lock Create or update a lockfile for the project's dependencies (experimental) + add Add one or more packages to the project's dependencies (experimental) + remove Remove one or more packages from the project's dependencies (experimental) + tree Display the dependency tree for the project (experimental) venv Create a virtual environment cache Manage the cache version Display uv's version @@ -738,16 +738,16 @@ fn help_with_no_pager() { Usage: uv [OPTIONS] Commands: - pip Resolve and install Python packages - tool Run and manage executable Python packages - python Manage Python installations - init Initialize a project - run Run a command in the project environment - sync Sync the project's dependencies with the environment - lock Resolve the project requirements into a lockfile - add Add one or more packages to the project requirements - remove Remove one or more packages from the project requirements - tree Display the dependency tree for the project + pip Manage Python packages with a pip-compatible interface + tool Run and manage tools provided by Python packages (experimental) + python Manage Python versions and installations (experimental) + init Create a new project (experimental) + run Run a command in an environment (experimental) + sync Update the project's environment to match the project's dependencies (experimental) + lock Create or update a lockfile for the project's dependencies (experimental) + add Add one or more packages to the project's dependencies (experimental) + remove Remove one or more packages from the project's dependencies (experimental) + tree Display the dependency tree for the project (experimental) venv Create a virtual environment cache Manage the cache version Display uv's version diff --git a/docs/reference/cli.md b/docs/reference/cli.md index a5cd15355..a0611fdaa 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -12,25 +12,25 @@ uv [OPTIONS]

Commands

-
uv pip

Resolve and install Python packages

+
uv pip

Manage Python packages with a pip-compatible interface

-
uv tool

Run and manage executable Python packages

+
uv tool

Run and manage tools provided by Python packages (experimental)

-
uv python

Manage Python installations

+
uv python

Manage Python versions and installations (experimental)

-
uv init

Initialize a project

+
uv init

Create a new project (experimental)

-
uv run

Run a command in the project environment

+
uv run

Run a command in an environment (experimental)

-
uv sync

Sync the project’s dependencies with the environment

+
uv sync

Update the project’s environment to match the project’s dependencies (experimental)

-
uv lock

Resolve the project requirements into a lockfile

+
uv lock

Create or update a lockfile for the project’s dependencies (experimental)

-
uv add

Add one or more packages to the project requirements

+
uv add

Add one or more packages to the project’s dependencies (experimental)

-
uv remove

Remove one or more packages from the project requirements

+
uv remove

Remove one or more packages from the project’s dependencies (experimental)

-
uv tree

Display the dependency tree for the project

+
uv tree

Display the dependency tree for the project (experimental)

uv venv

Create a virtual environment

@@ -44,7 +44,7 @@ uv [OPTIONS] ## uv pip -Resolve and install Python packages +Manage Python packages with a pip-compatible interface

Usage

@@ -778,7 +778,7 @@ uv pip check [OPTIONS] ## uv tool -Run and manage executable Python packages +Run and manage tools provided by Python packages (experimental)

Usage

@@ -1124,7 +1124,7 @@ uv tool dir [OPTIONS] ## uv python -Manage Python installations +Manage Python versions and installations (experimental)

Usage

@@ -1332,7 +1332,7 @@ uv python uninstall [OPTIONS] ... ## uv init -Initialize a project +Create a new project (experimental)

Usage

@@ -1380,7 +1380,7 @@ uv init [OPTIONS] [PATH] ## uv run -Run a command in the project environment +Run a command in an environment (experimental)

Usage

@@ -1488,7 +1488,7 @@ uv run [OPTIONS] ## uv sync -Sync the project's dependencies with the environment +Update the project's environment to match the project's dependencies (experimental)

Usage

@@ -1590,7 +1590,7 @@ uv sync [OPTIONS] ## uv lock -Resolve the project requirements into a lockfile +Create or update a lockfile for the project's dependencies (experimental)

Usage

@@ -1686,7 +1686,7 @@ uv lock [OPTIONS] ## uv add -Add one or more packages to the project requirements +Add one or more packages to the project's dependencies (experimental)

Usage

@@ -1800,7 +1800,7 @@ uv add [OPTIONS] ... ## uv remove -Remove one or more packages from the project requirements +Remove one or more packages from the project's dependencies (experimental)

Usage

@@ -1906,7 +1906,7 @@ uv remove [OPTIONS] ... ## uv tree -Display the dependency tree for the project +Display the dependency tree for the project (experimental)

Usage