Simplify management_cli.md CLI docs (#10799)

Offer just 1 easy option for installing with `uv tool` so people can get
started quickly
This commit is contained in:
Marc Abramowitz 2025-06-09 17:38:06 -07:00 committed by GitHub
parent ad9b79259f
commit 3bd36238dc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -19,34 +19,6 @@ and more, as well as making chat and HTTP requests to the proxy server.
If you have [uv](https://github.com/astral-sh/uv) installed, you can try this:
```shell
uvx --from=litellm[proxy] litellm-proxy
```
and if things are working, you should see something like this:
```shell
Usage: litellm-proxy [OPTIONS] COMMAND [ARGS]...
LiteLLM Proxy CLI - Manage your LiteLLM proxy server
Options:
--base-url TEXT Base URL of the LiteLLM proxy server [env var:
LITELLM_PROXY_URL]
--api-key TEXT API key for authentication [env var:
LITELLM_PROXY_API_KEY]
--help Show this message and exit.
Commands:
chat Chat with models through the LiteLLM proxy server
credentials Manage credentials for the LiteLLM proxy server
http Make HTTP requests to the LiteLLM proxy server
keys Manage API keys for the LiteLLM proxy server
models Manage models on your LiteLLM proxy server
```
If this works, you can make use of the tool more convenient by doing:
```shell
uv tool install litellm[proxy]
```
@ -64,25 +36,6 @@ and more, as well as making chat and HTTP requests to the proxy server.
litellm-proxy
```
In the future if you want to upgrade, you can do so with:
```shell
uv tool upgrade litellm[proxy]
```
or if you want to uninstall, you can do so with:
```shell
uv tool uninstall litellm
```
If you don't have uv or otherwise want to use pip, you can activate a virtual
environment and install the package manually:
```bash
pip install 'litellm[proxy]'
```
2. **Set up environment variables**
```bash
@ -104,13 +57,6 @@ and more, as well as making chat and HTTP requests to the proxy server.
- If you see an error, check your environment variables and proxy server status.
## Configuration
You can configure the CLI using environment variables or command-line options:
- `LITELLM_PROXY_URL`: Base URL of the LiteLLM proxy server (default: http://localhost:4000)
- `LITELLM_PROXY_API_KEY`: API key for authentication
## Main Commands
### Models Management