2024-06-26 12:28:42 -04:00
# First steps with uv
2024-07-22 13:15:11 -04:00
uv only provides a command-line interface and must be used from a terminal.
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
After [installing uv ](./installation.md ), you can check that uv is installed by running the `uv` command:
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
``` console
$ uv
2024-06-26 12:28:42 -04:00
```
2024-07-22 13:15:11 -04:00
You should see a help menu listing the available commands.
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
## Viewing the version
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
To check the installed version:
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
``` console
$ uv version
```
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
The following are also valid:
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
``` 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
```
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
## Help menus
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
The `--help` flag can be used to view the help menu for a command, e.g., for `uv` :
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
``` console
$ uv --help
```
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
To view the help menu for a specific command, e.g., for `uv init` :
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
``` console
$ uv init --help
```
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
When using the `--help` flag, uv displays a condensed help menu. To view a longer help menu for a command, use `uv help` :
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
``` console
$ uv help
```
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
To view the long help menu for a specific command, e.g., for `uv init` :
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
``` console
$ uv help init
```
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
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` .
2024-06-26 12:28:42 -04:00
2024-07-22 13:15:11 -04:00
## Next steps
2024-06-26 12:28:42 -04:00
2024-07-25 13:37:22 -04:00
Now that you've confirmed uv is installed and know how to get help, check out an [overview of features ](./features.md ) or jump straight into the [guides ](./guides/index.md ) to start using uv.