konsti
db371560bc
To enforce the 100 character line limit in markdown files introduced in https://github.com/astral-sh/uv/pull/5635, and to automate the formatting of markdown files, i've added prettier and formatted our markdown files with it. I've excluded the changelog and the generated references documentation from this for having too many changes, but we can also include them. I'm not particular on which style we use. My main motivations are (major) not having to reflow markdown files myself anymore and (minor) consistence between all markdown files. I've chosen prettier for similar reason as we chose black, it's a single good style that's automated and shared in the community. I do prefer prettier's style of not breaking inside of a link name though. This PR is in two parts, the first adds prettier to CI and documents using it, while the second actually formats the docs. When merge conflicts arise, we can drop the last commit and regenerate it with `npx prettier --prose-wrap always --write BENCHMARKS.md CONTRIBUTING.md README.md STYLE.md docs/*.md docs/concepts/**/*.md docs/guides/**/*.md docs/pip/**/*.md`. --------- Co-authored-by: Zanie Blue <contact@zanie.dev>
68 lines
1.5 KiB
Markdown
68 lines
1.5 KiB
Markdown
# First steps with uv
|
|
|
|
uv only provides a command-line interface and must be used from a terminal.
|
|
|
|
After [installing uv](./installation.md), you can check that uv is installed by running the `uv`
|
|
command:
|
|
|
|
```console
|
|
$ uv
|
|
```
|
|
|
|
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
|
|
[overview of features](./features.md) or jump straight into the [guides](./guides/index.md) to start
|
|
using uv.
|