uv icon indicating copy to clipboard operation
uv copied to clipboard

Better help for `uv run --help`

Open simonw opened this issue 1 year ago • 3 comments

Currently:

uv run --help

Output:

Run a command or script

Usage: uv run [OPTIONS] <COMMAND>

Options:
      --extra <EXTRA>
          Include optional dependencies from the extra group name
...

This isn't enough information. I want to understand how this differs from running the command directly. I was hoping to learn if it would automatically behave as if I had activated my .venv/ virtual environment, for example.

simonw avatar Aug 21 '24 16:08 simonw

At the bottom, we suggest uv run help to see the long-form help.

zanieb avatar Aug 21 '24 16:08 zanieb

that doesn't work for me - it invokes the "help" command instead

banana@valiarde MINGW64 ~/Documents/code/uv-test
$ uv run help
   Built uv-test @ file:///C:/Users/banana/Documents/code/uv-test
Uninstalled 1 package in 1ms
Installed 1 package in 6ms
For more information on a specific command, type HELP command-name
ASSOC          Displays or modifies file extension associations.
ATTRIB         Displays or changes file attributes.
BREAK          Sets or clears extended CTRL+C checking.
BCDEDIT        Sets properties in boot database to control boot loading.
CACLS          Displays or modifies access control lists (ACLs) of files.
CALL           Calls one batch program from another.
CD             Displays the name of or changes the current directory.
CHCP           Displays or sets the active code page number.
CHDIR          Displays the name of or changes the current directory.
CHKDSK         Checks a disk and displays a status report.

&c

gulbanana avatar Aug 22 '24 11:08 gulbanana

Sorry, uv help runuv help is the interface for the CLI reference.

zanieb avatar Aug 22 '24 12:08 zanieb