Hide

zanieb · zanieb · commit 83d8f8ab263f · 2025-11-11T09:17:48.000-06:00
diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs
@@ -520,7 +520,8 @@ pub enum Commands {
     /// Manage workspaces.
     #[command(
         after_help = "Use `uv help workspace` for more details.",
-        after_long_help = ""
+        after_long_help = "",
+        hide = true
     )]
     Workspace(WorkspaceNamespace),
     /// The implementation of the build backend.
@@ -6850,6 +6851,7 @@ pub struct WorkspaceNamespace {
 #[derive(Subcommand)]
 pub enum WorkspaceCommand {
     /// Display package metadata.
+    #[command(hide = true)]
     Metadata(MetadataArgs),
 }
 
diff --git a/crates/uv/src/commands/workspace/metadata.rs b/crates/uv/src/commands/workspace/metadata.rs
@@ -49,7 +49,7 @@ struct MetadataReport {
     members: Vec<WorkspaceMemberReport>,
 }
 
-/// Display package metadata.
+/// Display metadata about the workspace.
 pub(crate) async fn metadata(
     project_dir: &Path,
     preview: Preview,
diff --git a/crates/uv/tests/it/help.rs b/crates/uv/tests/it/help.rs
@@ -33,7 +33,6 @@ fn help() {
       venv                       Create a virtual environment
       build                      Build Python packages into source distributions and wheels
       publish                    Upload distributions to an index
-      workspace                  Manage workspaces
       cache                      Manage uv's cache
       self                       Manage the uv executable
       generate-shell-completion  Generate shell completion
@@ -99,27 +98,26 @@ fn help_flag() {
     Usage: uv [OPTIONS] <COMMAND>
 
     Commands:
-      auth       Manage authentication
-      run        Run a command or script
-      init       Create a new project
-      add        Add dependencies to the project
-      remove     Remove dependencies from the project
-      version    Read or update the project's version
-      sync       Update the project's environment
-      lock       Update the project's lockfile
-      export     Export the project's lockfile to an alternate format
-      tree       Display the project's dependency tree
-      format     Format Python code in the project
-      tool       Run and install commands provided by Python packages
-      python     Manage Python versions and installations
-      pip        Manage Python packages with a pip-compatible interface
-      venv       Create a virtual environment
-      build      Build Python packages into source distributions and wheels
-      publish    Upload distributions to an index
-      workspace  Manage workspaces
-      cache      Manage uv's cache
-      self       Manage the uv executable
-      help       Display documentation for a command
+      auth     Manage authentication
+      run      Run a command or script
+      init     Create a new project
+      add      Add dependencies to the project
+      remove   Remove dependencies from the project
+      version  Read or update the project's version
+      sync     Update the project's environment
+      lock     Update the project's lockfile
+      export   Export the project's lockfile to an alternate format
+      tree     Display the project's dependency tree
+      format   Format Python code in the project
+      tool     Run and install commands provided by Python packages
+      python   Manage Python versions and installations
+      pip      Manage Python packages with a pip-compatible interface
+      venv     Create a virtual environment
+      build    Build Python packages into source distributions and wheels
+      publish  Upload distributions to an index
+      cache    Manage uv's cache
+      self     Manage the uv executable
+      help     Display documentation for a command
 
     Cache options:
       -n, --no-cache               Avoid reading from or writing to the cache, instead using a temporary
@@ -180,27 +178,26 @@ fn help_short_flag() {
     Usage: uv [OPTIONS] <COMMAND>
 
     Commands:
-      auth       Manage authentication
-      run        Run a command or script
-      init       Create a new project
-      add        Add dependencies to the project
-      remove     Remove dependencies from the project
-      version    Read or update the project's version
-      sync       Update the project's environment
-      lock       Update the project's lockfile
-      export     Export the project's lockfile to an alternate format
-      tree       Display the project's dependency tree
-      format     Format Python code in the project
-      tool       Run and install commands provided by Python packages
-      python     Manage Python versions and installations
-      pip        Manage Python packages with a pip-compatible interface
-      venv       Create a virtual environment
-      build      Build Python packages into source distributions and wheels
-      publish    Upload distributions to an index
-      workspace  Manage workspaces
-      cache      Manage uv's cache
-      self       Manage the uv executable
-      help       Display documentation for a command
+      auth     Manage authentication
+      run      Run a command or script
+      init     Create a new project
+      add      Add dependencies to the project
+      remove   Remove dependencies from the project
+      version  Read or update the project's version
+      sync     Update the project's environment
+      lock     Update the project's lockfile
+      export   Export the project's lockfile to an alternate format
+      tree     Display the project's dependency tree
+      format   Format Python code in the project
+      tool     Run and install commands provided by Python packages
+      python   Manage Python versions and installations
+      pip      Manage Python packages with a pip-compatible interface
+      venv     Create a virtual environment
+      build    Build Python packages into source distributions and wheels
+      publish  Upload distributions to an index
+      cache    Manage uv's cache
+      self     Manage the uv executable
+      help     Display documentation for a command
 
     Cache options:
       -n, --no-cache               Avoid reading from or writing to the cache, instead using a temporary
@@ -895,7 +892,6 @@ fn help_unknown_subcommand() {
         venv
         build
         publish
-        workspace
         cache
         self
         generate-shell-completion
@@ -925,7 +921,6 @@ fn help_unknown_subcommand() {
         venv
         build
         publish
-        workspace
         cache
         self
         generate-shell-completion
@@ -984,7 +979,6 @@ fn help_with_global_option() {
       venv                       Create a virtual environment
       build                      Build Python packages into source distributions and wheels
       publish                    Upload distributions to an index
-      workspace                  Manage workspaces
       cache                      Manage uv's cache
       self                       Manage the uv executable
       generate-shell-completion  Generate shell completion
@@ -1108,7 +1102,6 @@ fn help_with_no_pager() {
       venv                       Create a virtual environment
       build                      Build Python packages into source distributions and wheels
       publish                    Upload distributions to an index
-      workspace                  Manage workspaces
       cache                      Manage uv's cache
       self                       Manage the uv executable
       generate-shell-completion  Generate shell completion
diff --git a/docs/concepts/preview.md b/docs/concepts/preview.md
@@ -72,6 +72,7 @@ The following preview features are available:
 - `format`: Allows using `uv format`.
 - `native-auth`: Enables storage of credentials in a
   [system-native location](../concepts/authentication/http.md#the-uv-credentials-store).
+- `workspace-metadata`: Allows using `uv workspace metadata`.
 
 ## Disabling preview features
 
diff --git a/docs/reference/cli.md b/docs/reference/cli.md
@@ -29,7 +29,6 @@ uv [OPTIONS] <COMMAND>
 <dt><a href="#uv-venv"><code>uv venv</code></a></dt><dd><p>Create a virtual environment</p></dd>
 <dt><a href="#uv-build"><code>uv build</code></a></dt><dd><p>Build Python packages into source distributions and wheels</p></dd>
 <dt><a href="#uv-publish"><code>uv publish</code></a></dt><dd><p>Upload distributions to an index</p></dd>
-<dt><a href="#uv-workspace"><code>uv workspace</code></a></dt><dd><p>Manage workspaces</p></dd>
 <dt><a href="#uv-cache"><code>uv cache</code></a></dt><dd><p>Manage uv's cache</p></dd>
 <dt><a href="#uv-self"><code>uv self</code></a></dt><dd><p>Manage the uv executable</p></dd>
 <dt><a href="#uv-help"><code>uv help</code></a></dt><dd><p>Display documentation for a command</p></dd>
@@ -5905,79 +5904,6 @@ uv publish --publish-url https://upload.pypi.org/legacy/ --check-url https://pyp
 <p>You can configure fine-grained logging using the <code>RUST_LOG</code> environment variable. (<a href="https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives">https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives</a>)</p>
 </dd></dl>
 
-## uv workspace
-
-Manage workspaces
-
-<h3 class="cli-reference">Usage</h3>
-
-```
-uv workspace [OPTIONS] <COMMAND>
-```
-
-<h3 class="cli-reference">Commands</h3>
-
-<dl class="cli-reference"><dt><a href="#uv-workspace-metadata"><code>uv workspace metadata</code></a></dt><dd><p>Display package metadata</p></dd>
-</dl>
-
-### uv workspace metadata
-
-Display package metadata
-
-<h3 class="cli-reference">Usage</h3>
-
-```
-uv workspace metadata [OPTIONS]
-```
-
-<h3 class="cli-reference">Options</h3>
-
-<dl class="cli-reference"><dt id="uv-workspace-metadata--allow-insecure-host"><a href="#uv-workspace-metadata--allow-insecure-host"><code>--allow-insecure-host</code></a>, <code>--trusted-host</code> <i>allow-insecure-host</i></dt><dd><p>Allow insecure connections to a host.</p>
-<p>Can be provided multiple times.</p>
-<p>Expects to receive either a hostname (e.g., <code>localhost</code>), a host-port pair (e.g., <code>localhost:8080</code>), or a URL (e.g., <code>https://localhost</code>).</p>
-<p>WARNING: Hosts included in this list will not be verified against the system's certificate store. Only use <code>--allow-insecure-host</code> in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.</p>
-<p>May also be set with the <code>UV_INSECURE_HOST</code> environment variable.</p></dd><dt id="uv-workspace-metadata--cache-dir"><a href="#uv-workspace-metadata--cache-dir"><code>--cache-dir</code></a> <i>cache-dir</i></dt><dd><p>Path to the cache directory.</p>
-<p>Defaults to <code>$XDG_CACHE_HOME/uv</code> or <code>$HOME/.cache/uv</code> on macOS and Linux, and <code>%LOCALAPPDATA%\uv\cache</code> on Windows.</p>
-<p>To view the location of the cache directory, run <code>uv cache dir</code>.</p>
-<p>May also be set with the <code>UV_CACHE_DIR</code> environment variable.</p></dd><dt id="uv-workspace-metadata--color"><a href="#uv-workspace-metadata--color"><code>--color</code></a> <i>color-choice</i></dt><dd><p>Control the use of color in output.</p>
-<p>By default, uv will automatically detect support for colors when writing to a terminal.</p>
-<p>Possible values:</p>
-<ul>
-<li><code>auto</code>:  Enables colored output only when the output is going to a terminal or TTY with support</li>
-<li><code>always</code>:  Enables colored output regardless of the detected environment</li>
-<li><code>never</code>:  Disables colored output</li>
-</ul></dd><dt id="uv-workspace-metadata--config-file"><a href="#uv-workspace-metadata--config-file"><code>--config-file</code></a> <i>config-file</i></dt><dd><p>The path to a <code>uv.toml</code> file to use for configuration.</p>
-<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
-<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p></dd><dt id="uv-workspace-metadata--directory"><a href="#uv-workspace-metadata--directory"><code>--directory</code></a> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
-<p>Relative paths are resolved with the given directory as the base.</p>
-<p>See <code>--project</code> to only change the project root directory.</p>
-<p>May also be set with the <code>UV_WORKING_DIRECTORY</code> environment variable.</p></dd><dt id="uv-workspace-metadata--help"><a href="#uv-workspace-metadata--help"><code>--help</code></a>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
-</dd><dt id="uv-workspace-metadata--managed-python"><a href="#uv-workspace-metadata--managed-python"><code>--managed-python</code></a></dt><dd><p>Require use of uv-managed Python versions.</p>
-<p>By default, uv prefers using Python versions it manages. However, it will use system Python versions if a uv-managed Python is not installed. This option disables use of system Python versions.</p>
-<p>May also be set with the <code>UV_MANAGED_PYTHON</code> environment variable.</p></dd><dt id="uv-workspace-metadata--native-tls"><a href="#uv-workspace-metadata--native-tls"><code>--native-tls</code></a></dt><dd><p>Whether to load TLS certificates from the platform's native certificate store.</p>
-<p>By default, uv loads certificates from the bundled <code>webpki-roots</code> crate. The <code>webpki-roots</code> are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).</p>
-<p>However, in some cases, you may want to use the platform's native certificate store, especially if you're relying on a corporate trust root (e.g., for a mandatory proxy) that's included in your system's certificate store.</p>
-<p>May also be set with the <code>UV_NATIVE_TLS</code> environment variable.</p></dd><dt id="uv-workspace-metadata--no-cache"><a href="#uv-workspace-metadata--no-cache"><code>--no-cache</code></a>, <code>--no-cache-dir</code>, <code>-n</code></dt><dd><p>Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation</p>
-<p>May also be set with the <code>UV_NO_CACHE</code> environment variable.</p></dd><dt id="uv-workspace-metadata--no-config"><a href="#uv-workspace-metadata--no-config"><code>--no-config</code></a></dt><dd><p>Avoid discovering configuration files (<code>pyproject.toml</code>, <code>uv.toml</code>).</p>
-<p>Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.</p>
-<p>May also be set with the <code>UV_NO_CONFIG</code> environment variable.</p></dd><dt id="uv-workspace-metadata--no-managed-python"><a href="#uv-workspace-metadata--no-managed-python"><code>--no-managed-python</code></a></dt><dd><p>Disable use of uv-managed Python versions.</p>
-<p>Instead, uv will search for a suitable Python version on the system.</p>
-<p>May also be set with the <code>UV_NO_MANAGED_PYTHON</code> environment variable.</p></dd><dt id="uv-workspace-metadata--no-progress"><a href="#uv-workspace-metadata--no-progress"><code>--no-progress</code></a></dt><dd><p>Hide all progress outputs.</p>
-<p>For example, spinners or progress bars.</p>
-<p>May also be set with the <code>UV_NO_PROGRESS</code> environment variable.</p></dd><dt id="uv-workspace-metadata--no-python-downloads"><a href="#uv-workspace-metadata--no-python-downloads"><code>--no-python-downloads</code></a></dt><dd><p>Disable automatic downloads of Python.</p>
-</dd><dt id="uv-workspace-metadata--offline"><a href="#uv-workspace-metadata--offline"><code>--offline</code></a></dt><dd><p>Disable network access.</p>
-<p>When disabled, uv will only use locally cached data and locally available files.</p>
-<p>May also be set with the <code>UV_OFFLINE</code> environment variable.</p></dd><dt id="uv-workspace-metadata--project"><a href="#uv-workspace-metadata--project"><code>--project</code></a> <i>project</i></dt><dd><p>Run the command within the given project directory.</p>
-<p>All <code>pyproject.toml</code>, <code>uv.toml</code>, and <code>.python-version</code> files will be discovered by walking up the directory tree from the project root, as will the project's virtual environment (<code>.venv</code>).</p>
-<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
-<p>See <code>--directory</code> to change the working directory entirely.</p>
-<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
-<p>May also be set with the <code>UV_PROJECT</code> environment variable.</p></dd><dt id="uv-workspace-metadata--quiet"><a href="#uv-workspace-metadata--quiet"><code>--quiet</code></a>, <code>-q</code></dt><dd><p>Use quiet output.</p>
-<p>Repeating this option, e.g., <code>-qq</code>, will enable a silent mode in which uv will write no output to stdout.</p>
-</dd><dt id="uv-workspace-metadata--verbose"><a href="#uv-workspace-metadata--verbose"><code>--verbose</code></a>, <code>-v</code></dt><dd><p>Use verbose output.</p>
-<p>You can configure fine-grained logging using the <code>RUST_LOG</code> environment variable. (<a href="https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives">https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives</a>)</p>
-</dd></dl>
-
 ## uv cache
 
 Manage uv's cache

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ struct MetadataReport {`
`49`	`49`	`members: Vec<WorkspaceMemberReport>,`
`50`	`50`	`}`
`51`	`51`
`52`		`-/// Display package metadata.`
	`52`	`+/// Display metadata about the workspace.`
`53`	`53`	`pub(crate) async fn metadata(`
`54`	`54`	`project_dir: &Path,`
`55`	`55`	`preview: Preview,`