..

docs/reference/cli.md

@@ -220,7 +220,9 @@ uv run [OPTIONS] [COMMAND]
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-run--index-proxy-url"><a href="#uv-run--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-run--index-proxy-url"><a href="#uv-run--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-run--index-strategy"><a href="#uv-run--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -896,7 +898,9 @@ uv add [OPTIONS] <PACKAGES|--requirements <REQUIREMENTS>>
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-add--index-proxy-url"><a href="#uv-add--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-add--index-proxy-url"><a href="#uv-add--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-add--index-strategy"><a href="#uv-add--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -1262,7 +1266,9 @@ uv remove [OPTIONS] <PACKAGES>...
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-remove--index-proxy-url"><a href="#uv-remove--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-remove--index-proxy-url"><a href="#uv-remove--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-remove--index-strategy"><a href="#uv-remove--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -1636,7 +1642,9 @@ uv sync [OPTIONS]
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-sync--index-proxy-url"><a href="#uv-sync--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-sync--index-proxy-url"><a href="#uv-sync--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-sync--index-strategy"><a href="#uv-sync--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -2019,7 +2027,9 @@ uv lock [OPTIONS]
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-lock--index-proxy-url"><a href="#uv-lock--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-lock--index-proxy-url"><a href="#uv-lock--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-lock--index-strategy"><a href="#uv-lock--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -2364,7 +2374,9 @@ uv export [OPTIONS]
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-export--index-proxy-url"><a href="#uv-export--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-export--index-proxy-url"><a href="#uv-export--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-export--index-strategy"><a href="#uv-export--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -2745,7 +2757,9 @@ uv tree [OPTIONS]
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-tree--index-proxy-url"><a href="#uv-tree--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-tree--index-proxy-url"><a href="#uv-tree--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-tree--index-strategy"><a href="#uv-tree--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -3230,7 +3244,9 @@ uv tool run [OPTIONS] [COMMAND]
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-tool-run--index-proxy-url"><a href="#uv-tool-run--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-tool-run--index-proxy-url"><a href="#uv-tool-run--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-tool-run--index-strategy"><a href="#uv-tool-run--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -3566,7 +3582,9 @@ uv tool install [OPTIONS] <PACKAGE>
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-tool-install--index-proxy-url"><a href="#uv-tool-install--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-tool-install--index-proxy-url"><a href="#uv-tool-install--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-tool-install--index-strategy"><a href="#uv-tool-install--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -3894,7 +3912,9 @@ uv tool upgrade [OPTIONS] <NAME>...
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-tool-upgrade--index-proxy-url"><a href="#uv-tool-upgrade--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-tool-upgrade--index-proxy-url"><a href="#uv-tool-upgrade--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-tool-upgrade--index-strategy"><a href="#uv-tool-upgrade--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -5717,7 +5737,9 @@ uv pip compile [OPTIONS] <SRC_FILE>...
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-pip-compile--index-proxy-url"><a href="#uv-pip-compile--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-pip-compile--index-proxy-url"><a href="#uv-pip-compile--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-pip-compile--index-strategy"><a href="#uv-pip-compile--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -6170,7 +6192,9 @@ uv pip sync [OPTIONS] <SRC_FILE>...
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-pip-sync--index-proxy-url"><a href="#uv-pip-sync--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-pip-sync--index-proxy-url"><a href="#uv-pip-sync--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-pip-sync--index-strategy"><a href="#uv-pip-sync--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -6597,7 +6621,9 @@ uv pip install [OPTIONS] <PACKAGE|--requirements <REQUIREMENTS>|--editable <EDIT
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-pip-install--index-proxy-url"><a href="#uv-pip-install--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-pip-install--index-proxy-url"><a href="#uv-pip-install--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-pip-install--index-strategy"><a href="#uv-pip-install--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -7339,7 +7365,9 @@ uv pip list [OPTIONS]
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-pip-list--index-proxy-url"><a href="#uv-pip-list--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-pip-list--index-proxy-url"><a href="#uv-pip-list--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-pip-list--index-strategy"><a href="#uv-pip-list--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -7693,7 +7721,9 @@ uv pip tree [OPTIONS]
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-pip-tree--index-proxy-url"><a href="#uv-pip-tree--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-pip-tree--index-proxy-url"><a href="#uv-pip-tree--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-pip-tree--index-strategy"><a href="#uv-pip-tree--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -8066,7 +8096,9 @@ uv venv [OPTIONS] [PATH]
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-venv--index-proxy-url"><a href="#uv-venv--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-venv--index-proxy-url"><a href="#uv-venv--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-venv--index-strategy"><a href="#uv-venv--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>
@@ -8359,7 +8391,9 @@ uv build [OPTIONS] [SRC]
 <p>All indexes provided via this flag take priority over the index specified by <code>--default-index</code> (which defaults to PyPI). When multiple <code>--index</code> flags are provided, earlier values take priority.</p>
 
 <p>May also be set with the <code>UV_INDEX</code> environment variable.</p>
-</dd><dt id="uv-build--index-proxy-url"><a href="#uv-build--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>FIXME Document</p>
+</dd><dt id="uv-build--index-proxy-url"><a href="#uv-build--index-proxy-url"><code>--index-proxy-url</code></a> <i>index-proxy-url</i></dt><dd><p>A proxy URL for an index replaces the canonical index URL specified in configuration. It will be used for dependency resolution and installation, but the canonical URL will be written to the lockfile.</p>
+
+<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
 
 <p>May also be set with the <code>UV_INDEX_PROXY_URL</code> environment variable.</p>
 </dd><dt id="uv-build--index-strategy"><a href="#uv-build--index-strategy"><code>--index-strategy</code></a> <i>index-strategy</i></dt><dd><p>The strategy to use when resolving against multiple index URLs.</p>

uv.schema.json

@@ -393,7 +393,7 @@
       ]
     },
     "proxy-urls": {
-      "description": "FIXME Document",
+      "description": "The optional URL of the index proxy. If it exists, it will be used instead of the canonical index URL for resolution and installation. The canonical URL will still be written to the lockfile.",
       "type": [
         "array",
         "null"
@@ -740,7 +740,7 @@
           ]
         },
         "proxy-url": {
-          "description": "FIXME Document",
+          "description": "The optional URL of the index proxy. If provided, it will be used instead of `Index.url` for resolution and installation. `Index.url` will still be written to the lockfile.\n\nExpects to receive a URL (e.g., `https://pypi.org/simple`) or a local path.",
           "anyOf": [
             {
               "$ref": "#/definitions/IndexUrl"
@@ -1371,7 +1371,6 @@
       ]
     },
     "ProxyUrl": {
-      "description": "FIXME Document",
       "type": "object",
       "required": [
         "name",