uv-help

Display general help for uv

$ uv help

$ uv help [command]

$ uv help [command] [subcommand]

$ uv help --no-pager [command]

uv help [SUBCOMMAND]

SUBCOMMAND
    Optional. The name of a specific uv subcommand (e.g., pip, venv, run, sync) for which to display detailed help. If omitted, general usage information for the uv tool itself is shown, listing all available top-level commands.

The uv help command is an integral part of the uv Python packaging tool, designed to provide comprehensive usage information.

While not a standalone executable named uv-help, it is correctly invoked as uv help or uv help <SUBCOMMAND>. This command is crucial for users to navigate the various functionalities offered by uv, a fast and modern alternative to pip and virtualenv.

When invoked without arguments, uv help displays a general overview of the uv tool, listing all available top-level commands (e.g., pip, venv, run) and their brief descriptions. This serves as an excellent starting point for discovering uv's capabilities.

For more specific assistance, users can provide a SUBCOMMAND (e.g., uv help pip or uv help venv). This will display detailed help for that particular subcommand, including all its specific options, arguments, and sometimes examples of its usage. This detailed help is invaluable for understanding the nuances of each uv operation, enabling users to effectively utilize this high-performance Python package manager.

The command uv-help does not exist as a standalone executable; the correct invocation is uv help as a subcommand of the uv tool. Using it requires the uv tool to be installed and available in the system's PATH. The displayed help content can be extensive, especially for subcommands with many options.

Running uv help without any arguments is the primary way to discover all top-level commands available within the uv tool. It presents a concise list of commands like pip, venv, run, build, sync, and others, each accompanied by a brief explanation of its purpose. This is essential for new users to grasp the breadth of uv's functionality and identify the appropriate command for their task.

To delve deeper into a specific command, users append its name to uv help (e.g., uv help pip or uv help venv). This action provides a detailed breakdown of the subcommand's syntax, its specific options (both short and long forms), expected arguments, and often practical examples. This level of detail is crucial for advanced usage, understanding command-specific behaviors, and troubleshooting issues.

uv is a relatively new, high-performance Python package installer and resolver written in Rust. Developed by Astral (now Rye), it was publicly released in late 2023 and quickly gained significant traction as a faster, more robust alternative to existing tools like pip and virtualenv.

The help subcommand, a standard feature in well-designed command-line interfaces, was implemented from uv's inception. Its inclusion reflects the developers' commitment to user-friendliness and discoverability, ensuring users can easily understand and leverage uv's extensive capabilities without needing to consult extensive external documentation.

uv(1), pip(1), venv(1)