Skip to content

Commit daa95cc

Browse files
authored
Update usage instructions for CLIProxyAPI setup
1 parent 3109b3a commit daa95cc

1 file changed

Lines changed: 15 additions & 7 deletions

File tree

docs/USAGE.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@ ZeroLimit is a Windows desktop application for monitoring AI coding assistant qu
44

55
## Prerequisites
66

7-
Before using ZeroLimit, you need to download CLIProxyAPI:
7+
Before using ZeroLimit, you need CLIProxyAPI running either **locally** or on a **remote server**:
88

9+
### Option A: Local Setup
910
1. Go to [CLIProxyAPI Releases](https://github.com/router-for-me/CLIProxyAPI/releases)
1011
2. Download `cli-proxy-api.exe` for Windows
1112
3. Extract to a folder (e.g., `C:\CLIProxyAPI\`)
1213

14+
### Option B: Remote Server
15+
If you have CLIProxyAPI running on a VPS with HTTPS:
16+
- You only need the API URL (e.g., `https://llm.yourdomain.com`)
17+
- No local installation required
18+
1319
## Getting Started
1420

1521
### 1. Installation
@@ -23,13 +29,14 @@ Before using ZeroLimit, you need to download CLIProxyAPI:
2329

2430
On first launch, you'll see the login screen with these sections:
2531

26-
1. **CLI Proxy Server**
32+
1. **CLI Proxy Server** (Local only)
2733
- Click **Change** to browse and select your `cli-proxy-api.exe`
2834
- Click **Start** to launch the proxy server
35+
- *Skip this if using a remote HTTPS server*
2936

3037
2. **API Base URL**
31-
- Default: `http://localhost:8317`
32-
- This is the address where CLIProxyAPI runs
38+
- **Local**: `http://localhost:8317`
39+
- **Remote HTTPS**: `https://llm.yourdomain.com`
3340

3441
3. **Management Key** (required)
3542
- Enter the `secret-key` from your CLIProxyAPI `config.yaml`
@@ -46,7 +53,7 @@ On first launch, you'll see the login screen with these sections:
4653

4754
| Setting | Description |
4855
|---------|-------------|
49-
| **Executable Path** | Path to `cli-proxy-api.exe` |
56+
| **Executable Path** | Path to `cli-proxy-api.exe` (local only) |
5057
| **Auto-start on launch** | Start proxy when app opens |
5158
| **Run in background** | Hide to system tray when closing |
5259

@@ -71,14 +78,15 @@ When "Run in background" is enabled:
7178

7279
## Troubleshooting
7380

74-
### Proxy Won't Start
81+
### Proxy Won't Start (Local)
7582
- Verify the executable path is correct
7683
- Check if another instance is already running
7784
- Try running as Administrator
7885

7986
### Connection Failed
80-
- Ensure CLI Proxy is running (green status)
87+
- Ensure CLI Proxy is running (green status for local)
8188
- Check the API Base URL is correct
89+
- For HTTPS: verify the SSL certificate is valid
8290
- Verify no firewall is blocking the port
8391

8492
### Login Failed

0 commit comments

Comments
 (0)