diff --git a/docs/getting-started/features.md b/docs/getting-started/features.md index 86450724e..3019cc332 100644 --- a/docs/getting-started/features.md +++ b/docs/getting-started/features.md @@ -100,5 +100,6 @@ self-update: ## Next steps -Read the [guides](../guides/index.md) for an introduction to each feature or check out -[concept](../concepts/index.md) pages for in-depth details about uv's features. +Read the [guides](../guides/index.md) for an introduction to each feature, check out +[concept](../concepts/index.md) pages for in-depth details about uv's features, or learn how to +[get help](./help.md) if you run into any problems. diff --git a/docs/getting-started/first-steps.md b/docs/getting-started/first-steps.md index d7ead0aba..e96bf7f45 100644 --- a/docs/getting-started/first-steps.md +++ b/docs/getting-started/first-steps.md @@ -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 diff --git a/docs/getting-started/help.md b/docs/getting-started/help.md new file mode 100644 index 000000000..ac0c0f631 --- /dev/null +++ b/docs/getting-started/help.md @@ -0,0 +1,61 @@ +# Getting help + +## 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 + +When seeking help, it's important to determine the version of uv that you're using — sometimes the +problem is already solved in a newer 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 +``` + +## Open an issue on GitHub + +The [issue tracker](https://github.com/astral-sh/uv/issues) on GitHub is a good place to report bugs +and request features. Make sure to search for similar issues first, as it is common for someone else +to encounter the same problem. + +## Chat on Discord + +Astral has a [Discord server](https://discord.com/invite/astral-sh), which is a great place to ask +questions, learn more about uv, and engage with other community members. diff --git a/mkdocs.template.yml b/mkdocs.template.yml index 007c5be8a..1ccd799cf 100644 --- a/mkdocs.template.yml +++ b/mkdocs.template.yml @@ -85,6 +85,7 @@ nav: - Installation: getting-started/installation.md - First steps: getting-started/first-steps.md - Features: getting-started/features.md + - Getting help: getting-started/help.md - Guides: - guides/index.md - Installing Python: guides/install-python.md