Zanie Blue
3228fc5f35
Improve the uv venv CLI documentation ( #5963 )
...
This was actually in pretty good shape already!
2024-08-09 12:15:22 -05:00
Zanie Blue
4330f9718b
Improve the uv lock CLI documentation ( #5932 )
2024-08-09 08:51:03 -05:00
Charlie Marsh
fd1d508108
Make --upgrade imply --refresh ( #5943 )
...
## Summary
I think this seems reasonable... Otherwise, we might not go back to PyPI
to revalidate the list of available versions despite the user passing
`--upgrade`.
2024-08-08 20:11:31 -04:00
Ahmed Ilyas
cbc3274848
Add uv tool upgrade command ( #5197 )
...
## Summary
Resolves #5188 . Most of the changes involve creating a new function in
`tool/common.rs` to contain the common functionality previously found in
`tool/install.rs`.
## Test Plan
`cargo test`
```console
❯ ./target/debug/uv tool upgrade black
warning: `uv tool upgrade` is experimental and may change without warning.
Resolved 6 packages in 25ms
Uninstalled 1 package in 3ms
Installed 1 package in 19ms
- black==23.1.0
+ black==24.4.2
Installed 2 executables: black, blackd
```
2024-08-08 16:48:14 -04:00
Zanie Blue
bf0497e652
Add CLI flags to reference documentation ( #5926 )
...
Oopsies, options are only arguments that take values in Clap-land
Closes https://github.com/astral-sh/uv/issues/5924
2024-08-08 18:51:27 +00:00
Zanie Blue
d2681320d3
Improve the CLI documentation for uv remove ( #5916 )
...
Also, renames a `requirements` variable to `packages` for clarity and
fixes the definition of `frozen` for `uv add`.
2024-08-08 13:12:49 -05:00
Zanie Blue
eb6251e0ed
Improve the CLI documentation for uv add ( #5914 )
2024-08-08 10:52:38 -05:00
Ahmed Ilyas
acbd367ead
Support no-build-isolation-package ( #5894 )
...
## Summary
Resolves #5831
## Test Plan
`cargo test`
2024-08-08 01:35:56 +00:00
Zanie Blue
c95bf76dfe
Replace uv help python references in CLI documentation with links ( #5871 )
...
Following #5869 , the documentation has some less-than-helpful
suggestions to use `uv help python` for details — we should link to the
`uv python` section instead.
2024-08-07 12:21:09 -05:00
Zanie Blue
fe2849af6a
Improve CLI documentation for uv tree ( #5870 )
2024-08-07 16:59:27 +00:00
Zanie Blue
2df2092084
Improve --python CLI documentation ( #5869 )
...
Closes #4400
2024-08-07 16:37:10 +00:00
Zanie Blue
32d8ea1698
Improve documentation for uv init CLI ( #5862 )
2024-08-07 11:26:00 -05:00
Zanie Blue
8998149ac1
Improve CLI documentation for uv run ( #5841 )
...
Adds more long-form help to `uv run`, which renders in `uv help run` and
the CLI reference on the website.
2024-08-07 13:26:24 +00:00
Zanie Blue
d1614c8f10
Improve CLI documentation for global options ( #5834 )
...
Slowly auditing our CLI help text
2024-08-06 20:50:29 -05:00
Zanie Blue
c0c26cc542
Improve display order of top-level commands ( #5830 )
...
Closes https://github.com/astral-sh/uv/issues/5702
Since Clap 4, the default order follows the declarations.
Also improves some descriptions.
2024-08-06 16:18:05 -05:00
Charlie Marsh
6b45baf7be
Support --python-platform in uv tree ( #5764 )
...
## Summary
This allows you to set (e.g.) `--python-platform windows` to view the
resolved dependencies on Windows.
Closes https://github.com/astral-sh/uv/issues/5760 .
2024-08-05 19:02:35 +00:00
eth3lbert
f2c4b9c752
Show default and possible options in CLI reference documentation ( #5720 )
...
## Summary
Closes #5692 .
2024-08-02 12:55:50 +00:00
Ahmed Ilyas
a6416aa450
Fix CLI reference URLs to subcommands ( #5722 )
...
## Summary
Currently all of these links end up 404-ed. I've added a `#` to fix the
URLs.
<img width="653" alt="Screenshot 2024-08-02 at 12 34 22"
src="https://github.com/user-attachments/assets/9b66adcc-431c-441a-8f4f-1b579472fdce ">
## Test Plan
Checked manually.
2024-08-02 07:35:33 -05:00
Ahmed Ilyas
ff9f3dede1
Support build constraints ( #5639 )
...
## Summary
Partially resolves #5561 . Haven't added overrides support yet but I can
add it tomorrow if the current approach for constraints is ok.
## Test Plan
`cargo test`
Manually checked trace logs after changing the constraints.
2024-08-02 02:15:58 +00:00
Zanie Blue
6797caccdb
Update top-level command descriptions ( #5706 )
...
Addresses feedback in https://github.com/astral-sh/uv/pull/5700
2024-08-01 20:29:26 +00:00
Zanie Blue
34f657c964
Unhide the experimental top-level commands ( #5700 )
2024-08-01 14:06:07 -05:00
Zanie Blue
f107406727
Generate CLI reference for documentation ( #5685 )
...
Loosely based on [Cargo's
format](https://github.com/rust-lang/cargo/blob/master/src/doc/src/commands/cargo-build.md )
<img width="896" alt="Screenshot 2024-08-01 at 9 44 03 AM"
src="https://github.com/user-attachments/assets/7c016bb3-2b54-46af-8ea8-ce82e07a0e30 ">
Future work includes:
- Grouping options
- Enforcing some sort of specific command ordering
- Showing possible values for enums
- Adding "long_about" to commands for more context
2024-08-01 16:04:16 +00:00
