Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Short name for "--group" option #11484

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+12 −12
Open

Short name for "--group" option #11484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
67518ca
Short name for "--group" option
hongquan Feb 13, 2025
81b711a
Add short name of "--group" for other commands
hongquan Feb 13, 2025
14201ea
Fix duplicate
hongquan Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions crates/uv-cli/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2709,7 +2709,7 @@ pub struct RunArgs {
/// Include dependencies from the specified dependency group.
///
/// May be provided multiple times.
#[arg(long, conflicts_with_all = ["only_group", "only_dev"])]
#[arg(long, short = 'G', conflicts_with_all = ["only_group", "only_dev"])]
pub group: Vec<GroupName>,

/// Disable the specified dependency group.
Expand Down Expand Up @@ -3004,7 +3004,7 @@ pub struct SyncArgs {
/// `tool.uv.conflicts`, uv will report an error.
///
/// May be provided multiple times.
#[arg(long, conflicts_with_all = ["only_group", "only_dev"])]
#[arg(long, short = 'G', conflicts_with_all = ["only_group", "only_dev"])]
pub group: Vec<GroupName>,

/// Disable the specified dependency group.
Expand Down Expand Up @@ -3281,7 +3281,7 @@ pub struct AddArgs {
/// Add the requirements to the specified dependency group.
///
/// These requirements will not be included in the published metadata for the project.
#[arg(long, conflicts_with("dev"), conflicts_with("optional"))]
#[arg(long, short = 'G', conflicts_with("dev"), conflicts_with("optional"))]
pub group: Option<GroupName>,

/// Add the requirements as editable.
Expand Down Expand Up @@ -3414,7 +3414,7 @@ pub struct RemoveArgs {
pub optional: Option<ExtraName>,

/// Remove the packages from the specified dependency group.
#[arg(long, conflicts_with("dev"), conflicts_with("optional"))]
#[arg(long, short = 'G', conflicts_with("dev"), conflicts_with("optional"))]
pub group: Option<GroupName>,

/// Avoid syncing the virtual environment after re-locking the project.
Expand Down Expand Up @@ -3523,7 +3523,7 @@ pub struct TreeArgs {
/// Include dependencies from the specified dependency group.
///
/// May be provided multiple times.
#[arg(long, conflicts_with_all = ["only_group", "only_dev"])]
#[arg(long, short = 'G', conflicts_with_all = ["only_group", "only_dev"])]
pub group: Vec<GroupName>,

/// Disable the specified dependency group.
Expand Down Expand Up @@ -3696,7 +3696,7 @@ pub struct ExportArgs {
/// Include dependencies from the specified dependency group.
///
/// May be provided multiple times.
#[arg(long, conflicts_with_all = ["only_group", "only_dev"])]
#[arg(long, short = 'G', conflicts_with_all = ["only_group", "only_dev"])]
pub group: Vec<GroupName>,

/// Disable the specified dependency group.
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ uv run [OPTIONS] [COMMAND]
<p>Instead of checking if the lockfile is up-to-date, uses the versions in the lockfile as the source of truth. If the lockfile is missing, uv will exit with an error. If the <code>pyproject.toml</code> includes changes to dependencies that have not been included in the lockfile yet, they will not be present in the environment.</p>

<p>May also be set with the <code>UV_FROZEN</code> environment variable.</p>
</dd><dt><code>--group</code> <i>group</i></dt><dd><p>Include dependencies from the specified dependency group.</p>
</dd><dt><code>--group</code>, <code>-G</code> <i>group</i></dt><dd><p>Include dependencies from the specified dependency group.</p>

<p>May be provided multiple times.</p>

Expand Down Expand Up @@ -880,7 +880,7 @@ uv add [OPTIONS] <PACKAGES|--requirements <REQUIREMENTS>>
<p>The project environment will not be synced.</p>

<p>May also be set with the <code>UV_FROZEN</code> environment variable.</p>
</dd><dt><code>--group</code> <i>group</i></dt><dd><p>Add the requirements to the specified dependency group.</p>
</dd><dt><code>--group</code>, <code>-G</code> <i>group</i></dt><dd><p>Add the requirements to the specified dependency group.</p>

<p>These requirements will not be included in the published metadata for the project.</p>

Expand Down Expand Up @@ -1245,7 +1245,7 @@ uv remove [OPTIONS] <PACKAGES>...
<p>The project environment will not be synced.</p>

<p>May also be set with the <code>UV_FROZEN</code> environment variable.</p>
</dd><dt><code>--group</code> <i>group</i></dt><dd><p>Remove the packages from the specified dependency group</p>
</dd><dt><code>--group</code>, <code>-G</code> <i>group</i></dt><dd><p>Remove the packages from the specified dependency group</p>

</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>

Expand Down Expand Up @@ -1612,7 +1612,7 @@ uv sync [OPTIONS]
<p>Instead of checking if the lockfile is up-to-date, uses the versions in the lockfile as the source of truth. If the lockfile is missing, uv will exit with an error. If the <code>pyproject.toml</code> includes changes to dependencies that have not been included in the lockfile yet, they will not be present in the environment.</p>

<p>May also be set with the <code>UV_FROZEN</code> environment variable.</p>
</dd><dt><code>--group</code> <i>group</i></dt><dd><p>Include dependencies from the specified dependency group.</p>
</dd><dt><code>--group</code>, <code>-G</code> <i>group</i></dt><dd><p>Include dependencies from the specified dependency group.</p>

<p>When multiple extras or groups are specified that appear in <code>tool.uv.conflicts</code>, uv will report an error.</p>

Expand Down Expand Up @@ -2336,7 +2336,7 @@ uv export [OPTIONS]
<p>If a <code>uv.lock</code> does not exist, uv will exit with an error.</p>

<p>May also be set with the <code>UV_FROZEN</code> environment variable.</p>
</dd><dt><code>--group</code> <i>group</i></dt><dd><p>Include dependencies from the specified dependency group.</p>
</dd><dt><code>--group</code>, <code>-G</code> <i>group</i></dt><dd><p>Include dependencies from the specified dependency group.</p>

<p>May be provided multiple times.</p>

Expand Down Expand Up @@ -2714,7 +2714,7 @@ uv tree [OPTIONS]
<p>If the lockfile is missing, uv will exit with an error.</p>

<p>May also be set with the <code>UV_FROZEN</code> environment variable.</p>
</dd><dt><code>--group</code> <i>group</i></dt><dd><p>Include dependencies from the specified dependency group.</p>
</dd><dt><code>--group</code>, <code>-G</code> <i>group</i></dt><dd><p>Include dependencies from the specified dependency group.</p>

<p>May be provided multiple times.</p>

Expand Down
Loading