pioduino/uv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Move help documentation into dedicated page (#6057)

Browse Source
This commit is contained in:
Zanie Blue
2024-08-13 11:09:32 -05:00
committed by GitHub
parent 037ba8419a
commit d20314038f
4 changed files with 65 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started/first-steps.md
-46
View File
@@ -17,52 +17,6 @@ You should see a help menu listing the available commands.
Read on for a brief overview of the help menu and version command, or jump to an
[overview of features](./features.md) to start using uv.
## Help menus
The `--help` flag can be used to view the help menu for a command, e.g., for `uv`:
```console
$ uv --help
```
To view the help menu for a specific command, e.g., for `uv init`:
```console
$ uv init --help
```
When using the `--help` flag, uv displays a condensed help menu. To view a longer help menu for a
command, use `uv help`:
```console
$ uv help
```
To view the long help menu for a specific command, e.g., for `uv init`:
```console
$ uv help init
```
When using the long help menu, uv will attempt to use `less` or `more` to "page" the output so it is
not all displayed at once. To exit the pager, press `q`.
## Viewing the version
To check the installed version:
```console
$ uv version
```
The following are also valid:
```console
$ uv --version # Same output as `uv version`
$ uv -V # Will not include the build commit and date
$ uv pip --version # Can be used with a subcommand
```
## Next steps
Now that you've confirmed uv is installed and know how to get help, check out an