You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat(onboarding): introduce new user onboarding and CLI Proxy setup
Introduce a new onboarding flow for first-time users.
Provide detailed instructions for CLI Proxy API setup, including auto-download, manual setup, and remote server options.
Update `README.md` to reference the new onboarding section.
Add `onboard.png` and update other screenshots to reflect the new UI.
docs(usage): update usage guide with new settings, languages, and fixes
Expand supported languages in `docs/USAGE.md` to include Japanese, Vietnamese, Thai, and Korean.
Add new settings for checking and updating the CLI Proxy in `docs/USAGE.md`.
Improve troubleshooting section in `docs/USAGE.md` for auto-download failures.
Correct provider name from "Kirocode" to "Kiro" in `README.md`.
Copy file name to clipboardExpand all lines: docs/USAGE.md
+50-32Lines changed: 50 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,50 +1,61 @@
1
1
# How to Use ZeroLimit
2
+
## Getting Started
2
3
3
-
ZeroLimit is a Windows desktop application for monitoring AI coding assistant quotas. Track your usage across Antigravity, Anthropic Claude, Codex (OpenAI), and Gemini CLI accounts in one dashboard.
4
+
### 1. Installation
5
+
- Download `ZeroLimit_x.x.x_x64-setup` from Releases
6
+
- Run the installer
7
+
- Launch ZeroLimit from Start Menu
4
8
5
-
##Prerequisites
9
+
### 2. First Launch - Onboarding
6
10
7
-
Before using ZeroLimit, you need CLIProxyAPI running either **locally** or on a **remote server**:
11
+
On first launch, you'll be guided through a setup wizard to configure CLIProxyAPI. You can choose between two setup modes:
8
12
9
-
### Option A: Local Setup
10
-
> [!NOTE]
11
-
> if you want to use kiro & github copilot support, you need to download [CLIProxyAPI Plus Version](https://github.com/router-for-me/CLIProxyAPIPlus/releases)
13
+
---
12
14
13
-
### Option A: Local Setup
14
-
1. Go to [CLIProxyAPI Releases](https://github.com/router-for-me/CLIProxyAPI/releases)
15
-
2. Download `cli-proxy-api.exe` for Windows
16
-
3. Extract to a folder (e.g., `C:\CLIProxyAPI\`)
15
+
#### Option A: Auto Download (Recommended)
17
16
18
-
## Getting Started
17
+
The easiest way to get started. ZeroLimit will automatically download and configure the CLI Proxy for you.
19
18
20
-
### 1. Installation
19
+
1. Click **Get Started** on the welcome screen
20
+
2. Select **Auto Download**
21
+
3. Choose your version:
22
+
-**Standard** — The original CLI Proxy API
23
+
-**Plus** — Enhanced version with GitHub Copilot and Kiro support
24
+
4. ZeroLimit will download and extract the correct binary for your OS
25
+
5. Set a **Management Key** — this is the secret key used to protect the management API
26
+
6. Click **Finish Setup** — the proxy starts automatically and you're logged in
21
27
22
-
**Windows:**
23
-
-Download `ZeroLimit_x.x.x_x64-setup.exe` from Releases
24
-
- Run the installer
25
-
- Launch ZeroLimit from Start Menu
28
+
> [!TIP]
29
+
> The Auto Download mode handles everything: downloading the binary, writing the `config.yaml`, starting the server, and logging you in — all in one flow.
30
+
31
+
---
26
32
27
-
###2. First Launch - Login
33
+
#### Option B: Manual Setup
28
34
29
-
On first launch, you'll see the login screen with these sections:
35
+
If you already have CLIProxyAPI downloaded or prefer to manage it yourself:
30
36
31
-
1.**CLI Proxy Server** (Local only)
32
-
- Click **Change** to browse and select your `cli-proxy-api.exe`
33
-
- Click **Start** to launch the proxy server
34
-
-*Skip this if using a remote HTTPS server*
37
+
1. Click **Get Started** on the welcome screen
38
+
2. Select **Manual Location**
39
+
3. Browse and select your `cli-proxy-api.exe` (or `cli-proxy-api-plus.exe`)
40
+
4. Set a **Management Key**
41
+
5. Click **Finish Setup**
35
42
36
-
2.**API Base URL**
37
-
-**Local**: `http://localhost:8317`
38
-
-**Remote HTTPS**: `https://llm.yourdomain.com`
39
43
40
-
3.**Management Key** (required)
41
-
- Enter the `secret-key` from your CLIProxyAPI `config.yaml`
42
-
- This key is required for authentication
43
44
44
-
4.**Remember credentials**
45
-
- Check to save your settings for next time
45
+
> [!NOTE]
46
+
> For the Plus version with Kiro & GitHub Copilot support, download from [CLIProxyAPI Plus Releases](https://github.com/router-for-me/CLIProxyAPIPlus/releases).
47
+
> For the Standard version, download from [CLIProxyAPI Releases](https://github.com/router-for-me/CLIProxyAPI/releases).
48
+
49
+
---
46
50
47
-
5. Click **Login** to connect to the dashboard
51
+
#### Option C: Remote Server
52
+
53
+
If you're connecting to a remote HTTPS server, click **Skip For Now** during onboarding and log in manually:
54
+
55
+
1. Enter your **API Base URL** (e.g., `https://llm.yourdomain.com`)
56
+
2. Enter the **Management Key** from your server's `config.yaml`
57
+
3. Check **Remember credentials** to save for next time
58
+
4. Click **Login**
48
59
49
60
## Settings
50
61
@@ -55,11 +66,13 @@ On first launch, you'll see the login screen with these sections:
55
66
|**Executable Path**| Path to `cli-proxy-api.exe` (local only) |
56
67
|**Auto-start on launch**| Start proxy when app opens |
57
68
|**Run in background**| Hide to system tray when closing |
69
+
|**Check for Updates**| Check if a newer CLI Proxy version is available |
70
+
|**Update Proxy**| Download and install the latest version automatically |
58
71
59
72
### Theme & Language
60
73
61
74
-**Theme**: Light, Dark, or System
62
-
-**Language**: English, Chinese, Indonesian
75
+
-**Language**: English, Chinese, Indonesian, Japanese, Vietnamese, Thai, Korean
63
76
64
77
## System Tray
65
78
@@ -82,6 +95,11 @@ When "Run in background" is enabled:
82
95
- Check if another instance is already running
83
96
- Try running as Administrator
84
97
98
+
### Auto Download Failed
99
+
- Check your internet connection
100
+
- GitHub API may be rate-limited — try again in a few minutes
101
+
- Fall back to Manual Setup and download the binary yourself
102
+
85
103
### Connection Failed
86
104
- Ensure CLI Proxy is running (green status for local)
0 commit comments