Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update top-level command descriptions (#5706) 

Addresses feedback in https://github.com/astral-sh/uv/pull/5700
This commit is contained in:
Zanie Blue 2024-08-01 15:29:26 -05:00 committed by GitHub
parent 3a8ee0be57
commit 6797caccdb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 82 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
crates/uv-cli/src/lib.rs
View File

@ -213,19 +213,19 @@ impl From<ColorChoice> for anstream::ColorChoice {
#[derive(Subcommand)] #[derive(Subcommand)]
#[allow(clippy::large_enum_variant)] #[allow(clippy::large_enum_variant)]
pub enum Commands { pub enum Commands {
/// Resolve and install Python packages. /// Manage Python packages with a pip-compatible interface.
#[command( #[command(
after_help = "Use `uv help pip`` for more details.", after_help = "Use `uv help pip`` for more details.",
after_long_help = "" after_long_help = ""
)] )]
Pip(PipNamespace), Pip(PipNamespace),
/// Run and manage executable Python packages. /// Run and manage tools provided by Python packages (experimental).
#[command( #[command(
after_help = "Use `uv help tool` for more details.", after_help = "Use `uv help tool` for more details.",
after_long_help = "" after_long_help = ""
)] )]
Tool(ToolNamespace), Tool(ToolNamespace),
/// Manage Python installations. /// Manage Python versions and installations (experimental).
#[command( #[command(
after_help = "Use `uv help python` for more details.", after_help = "Use `uv help python` for more details.",
after_long_help = "" after_long_help = ""
@ -415,39 +415,39 @@ pub enum PipCommand {
#[derive(Subcommand)] #[derive(Subcommand)]
pub enum ProjectCommand { pub enum ProjectCommand {
/// Initialize a project. /// Create a new project (experimental).
Init(InitArgs), Init(InitArgs),
/// Run a command in the project environment. /// Run a command in an environment (experimental).
#[command( #[command(
after_help = "Use `uv help run` for more details.", after_help = "Use `uv help run` for more details.",
after_long_help = "" after_long_help = ""
)] )]
Run(RunArgs), Run(RunArgs),
/// Sync the project's dependencies with the environment. /// Update the project's environment to match the project's dependencies (experimental).
#[command( #[command(
after_help = "Use `uv help sync` for more details.", after_help = "Use `uv help sync` for more details.",
after_long_help = "" after_long_help = ""
)] )]
Sync(SyncArgs), Sync(SyncArgs),
/// Resolve the project requirements into a lockfile. /// Create or update a lockfile for the project's dependencies (experimental).
#[command( #[command(
after_help = "Use `uv help lock` for more details.", after_help = "Use `uv help lock` for more details.",
after_long_help = "" after_long_help = ""
)] )]
Lock(LockArgs), Lock(LockArgs),
/// Add one or more packages to the project requirements. /// Add one or more packages to the project's dependencies (experimental).
#[command( #[command(
after_help = "Use `uv help add` for more details.", after_help = "Use `uv help add` for more details.",
after_long_help = "" after_long_help = ""
)] )]
Add(AddArgs), Add(AddArgs),
/// Remove one or more packages from the project requirements. /// Remove one or more packages from the project's dependencies (experimental).
#[command( #[command(
after_help = "Use `uv help remove` for more details.", after_help = "Use `uv help remove` for more details.",
after_long_help = "" after_long_help = ""
)] )]
Remove(RemoveArgs), Remove(RemoveArgs),
/// Display the dependency tree for the project. /// Display the dependency tree for the project (experimental).
Tree(TreeArgs), Tree(TreeArgs),
} }

104
crates/uv/tests/help.rs
View File

@ -16,16 +16,16 @@ fn help() {
Usage: uv [OPTIONS] <COMMAND> Usage: uv [OPTIONS] <COMMAND>
Commands: Commands:
pip Resolve and install Python packages pip Manage Python packages with a pip-compatible interface
tool Run and manage executable Python packages tool Run and manage tools provided by Python packages (experimental)
python Manage Python installations python Manage Python versions and installations (experimental)
init Initialize a project init Create a new project (experimental)
run Run a command in the project environment run Run a command in an environment (experimental)
sync Sync the project's dependencies with the environment sync Update the project's environment to match the project's dependencies (experimental)
lock Resolve the project requirements into a lockfile lock Create or update a lockfile for the project's dependencies (experimental)
add Add one or more packages to the project requirements add Add one or more packages to the project's dependencies (experimental)
remove Remove one or more packages from the project requirements remove Remove one or more packages from the project's dependencies (experimental)
tree Display the dependency tree for the project tree Display the dependency tree for the project (experimental)
venv Create a virtual environment venv Create a virtual environment
cache Manage the cache cache Manage the cache
version Display uv's version version Display uv's version
@ -82,16 +82,16 @@ fn help_flag() {
Usage: uv [OPTIONS] <COMMAND> Usage: uv [OPTIONS] <COMMAND>
Commands: Commands:
pip Resolve and install Python packages pip Manage Python packages with a pip-compatible interface
tool Run and manage executable Python packages tool Run and manage tools provided by Python packages (experimental)
python Manage Python installations python Manage Python versions and installations (experimental)
init Initialize a project init Create a new project (experimental)
run Run a command in the project environment run Run a command in an environment (experimental)
sync Sync the project's dependencies with the environment sync Update the project's environment to match the project's dependencies (experimental)
lock Resolve the project requirements into a lockfile lock Create or update a lockfile for the project's dependencies (experimental)
add Add one or more packages to the project requirements add Add one or more packages to the project's dependencies (experimental)
remove Remove one or more packages from the project requirements remove Remove one or more packages from the project's dependencies (experimental)
tree Display the dependency tree for the project tree Display the dependency tree for the project (experimental)
venv Create a virtual environment venv Create a virtual environment
cache Manage the cache cache Manage the cache
version Display uv's version version Display uv's version
@ -147,16 +147,16 @@ fn help_short_flag() {
Usage: uv [OPTIONS] <COMMAND> Usage: uv [OPTIONS] <COMMAND>
Commands: Commands:
pip Resolve and install Python packages pip Manage Python packages with a pip-compatible interface
tool Run and manage executable Python packages tool Run and manage tools provided by Python packages (experimental)
python Manage Python installations python Manage Python versions and installations (experimental)
init Initialize a project init Create a new project (experimental)
run Run a command in the project environment run Run a command in an environment (experimental)
sync Sync the project's dependencies with the environment sync Update the project's environment to match the project's dependencies (experimental)
lock Resolve the project requirements into a lockfile lock Create or update a lockfile for the project's dependencies (experimental)
add Add one or more packages to the project requirements add Add one or more packages to the project's dependencies (experimental)
remove Remove one or more packages from the project requirements remove Remove one or more packages from the project's dependencies (experimental)
tree Display the dependency tree for the project tree Display the dependency tree for the project (experimental)
venv Create a virtual environment venv Create a virtual environment
cache Manage the cache cache Manage the cache
version Display uv's version version Display uv's version
@ -208,7 +208,7 @@ fn help_subcommand() {
success: true success: true
exit_code: 0 exit_code: 0
----- stdout ----- ----- stdout -----
Manage Python installations Manage Python versions and installations (experimental)
Usage: uv python [OPTIONS] <COMMAND> Usage: uv python [OPTIONS] <COMMAND>
@ -450,7 +450,7 @@ fn help_flag_subcommand() {
success: true success: true
exit_code: 0 exit_code: 0
----- stdout ----- ----- stdout -----
Manage Python installations Manage Python versions and installations (experimental)
Usage: uv python [OPTIONS] <COMMAND> Usage: uv python [OPTIONS] <COMMAND>
@ -636,16 +636,16 @@ fn help_with_global_option() {
Usage: uv [OPTIONS] <COMMAND> Usage: uv [OPTIONS] <COMMAND>
Commands: Commands:
pip Resolve and install Python packages pip Manage Python packages with a pip-compatible interface
tool Run and manage executable Python packages tool Run and manage tools provided by Python packages (experimental)
python Manage Python installations python Manage Python versions and installations (experimental)
init Initialize a project init Create a new project (experimental)
run Run a command in the project environment run Run a command in an environment (experimental)
sync Sync the project's dependencies with the environment sync Update the project's environment to match the project's dependencies (experimental)
lock Resolve the project requirements into a lockfile lock Create or update a lockfile for the project's dependencies (experimental)
add Add one or more packages to the project requirements add Add one or more packages to the project's dependencies (experimental)
remove Remove one or more packages from the project requirements remove Remove one or more packages from the project's dependencies (experimental)
tree Display the dependency tree for the project tree Display the dependency tree for the project (experimental)
venv Create a virtual environment venv Create a virtual environment
cache Manage the cache cache Manage the cache
version Display uv's version version Display uv's version
@ -738,16 +738,16 @@ fn help_with_no_pager() {
Usage: uv [OPTIONS] <COMMAND> Usage: uv [OPTIONS] <COMMAND>
Commands: Commands:
pip Resolve and install Python packages pip Manage Python packages with a pip-compatible interface
tool Run and manage executable Python packages tool Run and manage tools provided by Python packages (experimental)
python Manage Python installations python Manage Python versions and installations (experimental)
init Initialize a project init Create a new project (experimental)
run Run a command in the project environment run Run a command in an environment (experimental)
sync Sync the project's dependencies with the environment sync Update the project's environment to match the project's dependencies (experimental)
lock Resolve the project requirements into a lockfile lock Create or update a lockfile for the project's dependencies (experimental)
add Add one or more packages to the project requirements add Add one or more packages to the project's dependencies (experimental)
remove Remove one or more packages from the project requirements remove Remove one or more packages from the project's dependencies (experimental)
tree Display the dependency tree for the project tree Display the dependency tree for the project (experimental)
venv Create a virtual environment venv Create a virtual environment
cache Manage the cache cache Manage the cache
version Display uv's version version Display uv's version

40
docs/reference/cli.md
View File

@ -12,25 +12,25 @@ uv [OPTIONS] <COMMAND>
<h3 class="cli-reference">Commands</h3> <h3 class="cli-reference">Commands</h3>
<dl class="cli-reference"><dt><a href="uv-pip"><code>uv pip</code></a></dt><dd><p>Resolve and install Python packages</p> <dl class="cli-reference"><dt><a href="uv-pip"><code>uv pip</code></a></dt><dd><p>Manage Python packages with a pip-compatible interface</p>
</dd> </dd>
<dt><a href="uv-tool"><code>uv tool</code></a></dt><dd><p>Run and manage executable Python packages</p> <dt><a href="uv-tool"><code>uv tool</code></a></dt><dd><p>Run and manage tools provided by Python packages (experimental)</p>
</dd> </dd>
<dt><a href="uv-python"><code>uv python</code></a></dt><dd><p>Manage Python installations</p> <dt><a href="uv-python"><code>uv python</code></a></dt><dd><p>Manage Python versions and installations (experimental)</p>
</dd> </dd>
<dt><a href="uv-init"><code>uv init</code></a></dt><dd><p>Initialize a project</p> <dt><a href="uv-init"><code>uv init</code></a></dt><dd><p>Create a new project (experimental)</p>
</dd> </dd>
<dt><a href="uv-run"><code>uv run</code></a></dt><dd><p>Run a command in the project environment</p> <dt><a href="uv-run"><code>uv run</code></a></dt><dd><p>Run a command in an environment (experimental)</p>
</dd> </dd>
<dt><a href="uv-sync"><code>uv sync</code></a></dt><dd><p>Sync the project&#8217;s dependencies with the environment</p> <dt><a href="uv-sync"><code>uv sync</code></a></dt><dd><p>Update the project&#8217;s environment to match the project&#8217;s dependencies (experimental)</p>
</dd> </dd>
<dt><a href="uv-lock"><code>uv lock</code></a></dt><dd><p>Resolve the project requirements into a lockfile</p> <dt><a href="uv-lock"><code>uv lock</code></a></dt><dd><p>Create or update a lockfile for the project&#8217;s dependencies (experimental)</p>
</dd> </dd>
<dt><a href="uv-add"><code>uv add</code></a></dt><dd><p>Add one or more packages to the project requirements</p> <dt><a href="uv-add"><code>uv add</code></a></dt><dd><p>Add one or more packages to the project&#8217;s dependencies (experimental)</p>
</dd> </dd>
<dt><a href="uv-remove"><code>uv remove</code></a></dt><dd><p>Remove one or more packages from the project requirements</p> <dt><a href="uv-remove"><code>uv remove</code></a></dt><dd><p>Remove one or more packages from the project&#8217;s dependencies (experimental)</p>
</dd> </dd>
<dt><a href="uv-tree"><code>uv tree</code></a></dt><dd><p>Display the dependency tree for the project</p> <dt><a href="uv-tree"><code>uv tree</code></a></dt><dd><p>Display the dependency tree for the project (experimental)</p>
</dd> </dd>
<dt><a href="uv-venv"><code>uv venv</code></a></dt><dd><p>Create a virtual environment</p> <dt><a href="uv-venv"><code>uv venv</code></a></dt><dd><p>Create a virtual environment</p>
</dd> </dd>
@ -44,7 +44,7 @@ uv [OPTIONS] <COMMAND>
## uv pip ## uv pip
Resolve and install Python packages Manage Python packages with a pip-compatible interface
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>
@ -778,7 +778,7 @@ uv pip check [OPTIONS]
## uv tool ## uv tool
Run and manage executable Python packages Run and manage tools provided by Python packages (experimental)
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>
@ -1124,7 +1124,7 @@ uv tool dir [OPTIONS]
## uv python ## uv python
Manage Python installations Manage Python versions and installations (experimental)
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>
@ -1332,7 +1332,7 @@ uv python uninstall [OPTIONS] <TARGETS>...
## uv init ## uv init
Initialize a project Create a new project (experimental)
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>
@ -1380,7 +1380,7 @@ uv init [OPTIONS] [PATH]
## uv run ## uv run
Run a command in the project environment Run a command in an environment (experimental)
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>
@ -1488,7 +1488,7 @@ uv run [OPTIONS] <COMMAND>
## uv sync ## uv sync
Sync the project's dependencies with the environment Update the project's environment to match the project's dependencies (experimental)
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>
@ -1590,7 +1590,7 @@ uv sync [OPTIONS]
## uv lock ## uv lock
Resolve the project requirements into a lockfile Create or update a lockfile for the project's dependencies (experimental)
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>
@ -1686,7 +1686,7 @@ uv lock [OPTIONS]
## uv add ## uv add
Add one or more packages to the project requirements Add one or more packages to the project's dependencies (experimental)
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>
@ -1800,7 +1800,7 @@ uv add [OPTIONS] <REQUIREMENTS>...
## uv remove ## uv remove
Remove one or more packages from the project requirements Remove one or more packages from the project's dependencies (experimental)
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>
@ -1906,7 +1906,7 @@ uv remove [OPTIONS] <REQUIREMENTS>...
## uv tree ## uv tree
Display the dependency tree for the project Display the dependency tree for the project (experimental)
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>