From af1ea045c5bd06b2bdae1e763e711f29ce008ff8 Mon Sep 17 00:00:00 2001 From: John Mumm Date: Thu, 27 Feb 2025 10:20:32 +0100 Subject: [PATCH] .. --- docs/reference/cli.md | 68 ++++++++++++++++++++++++++++++++----------- uv.schema.json | 5 ++-- 2 files changed, 53 insertions(+), 20 deletions(-) diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 4d4842dd1..ad437612f 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -220,7 +220,9 @@ uv run [OPTIONS] [COMMAND]

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -896,7 +898,9 @@ uv add [OPTIONS] >

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -1262,7 +1266,9 @@ uv remove [OPTIONS] ...

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -1636,7 +1642,9 @@ uv sync [OPTIONS]

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -2019,7 +2027,9 @@ uv lock [OPTIONS]

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -2364,7 +2374,9 @@ uv export [OPTIONS]

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -2745,7 +2757,9 @@ uv tree [OPTIONS]

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -3230,7 +3244,9 @@ uv tool run [OPTIONS] [COMMAND]

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -3566,7 +3582,9 @@ uv tool install [OPTIONS]

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -3894,7 +3912,9 @@ uv tool upgrade [OPTIONS] ...

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -5717,7 +5737,9 @@ uv pip compile [OPTIONS] ...

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -6170,7 +6192,9 @@ uv pip sync [OPTIONS] ...

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -6597,7 +6621,9 @@ uv pip install [OPTIONS] |--editable All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -7339,7 +7365,9 @@ uv pip list [OPTIONS]

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -7693,7 +7721,9 @@ uv pip tree [OPTIONS]

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -8066,7 +8096,9 @@ uv venv [OPTIONS] [PATH]

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

@@ -8359,7 +8391,9 @@ uv build [OPTIONS] [SRC]

All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

May also be set with the UV_INDEX environment variable.

-
--index-proxy-url index-proxy-url

FIXME Document

+
--index-proxy-url index-proxy-url

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.

+ +

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

May also be set with the UV_INDEX_PROXY_URL environment variable.

--index-strategy index-strategy

The strategy to use when resolving against multiple index URLs.

diff --git a/uv.schema.json b/uv.schema.json index 838ffe50a..770127a33 100644 --- a/uv.schema.json +++ b/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",