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
Copy file name to clipboardExpand all lines: README.md
+25-26Lines changed: 25 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
# CLI Proxy API Management Center
2
2
3
-
A single-file Web UI (React + TypeScript) for operating and troubleshooting the **CLI Proxy API** via its **Management API** (config, credentials, logs, and usage).
3
+
A single-file Web UI (React + TypeScript) for operating and troubleshooting the **CLI Proxy API** via its **Management API** (config, credentials, and logs).
Since version 6.0.19, the Web UI ships with the main program; access it via `/management.html` on the API port once the service is running.
12
12
13
13
## What this is (and isn’t)
14
14
15
-
- This repository is the Web UI only. It talks to the CLI Proxy API **Management API** (`/v0/management`) to read/update config, upload credentials, view logs, and inspect usage.
15
+
- This repository is the Web UI only. It talks to the CLI Proxy API **Management API** (`/v0/management`) to read/update config, upload credentials, and view logs.
16
16
- It is **not** a proxy and does not forward traffic.
17
17
18
18
## Quick start
@@ -28,22 +28,22 @@ The address is auto-detected from the current page URL; manual override is suppo
28
28
### Option B: Run the dev server
29
29
30
30
```bash
31
-
npm install
32
-
npm run dev
31
+
bun install --frozen-lockfile
32
+
bun run dev
33
33
```
34
34
35
35
Open `http://localhost:5173`, then connect to your CLI Proxy API backend instance.
36
36
37
37
### Option C: Build a single HTML file
38
38
39
39
```bash
40
-
npm install
41
-
npm run build
40
+
bun install --frozen-lockfile
41
+
bun run build
42
42
```
43
43
44
44
- Output: `dist/index.html` (all assets are inlined).
45
45
- For CLI Proxy API bundling, the release workflow renames it to `management.html`.
46
-
- To preview locally: `npm run preview`
46
+
- To preview locally: `bun run preview`
47
47
48
48
Tip: opening `dist/index.html` via `file://` may be blocked by browser CORS; serving it (preview/static server) is more reliable.
49
49
@@ -69,46 +69,45 @@ This is different from the proxy `api-keys` you manage inside the UI (those are
69
69
### Remote management
70
70
71
71
If you connect from a non-localhost browser, the server must allow remote management (e.g. `allow-remote-management: true`).
72
-
See `api.md` for the full authentication rules, server-side limits, and edge cases.
72
+
Check the CLI Proxy API server documentation/config comments for the full authentication rules, server-side limits, and edge cases.
73
73
74
74
## What you can manage (mapped to the UI pages)
75
75
76
76
-**Dashboard**: connection status, server version/build date, quick counts, model availability snapshot.
-**Config Panel**: visual editor for common `config.yaml` fields, basic settings, proxy `api-keys`, and source editing with YAML highlighting/search plus a save diff preview.
-**System**: quick links + fetch `/v1/models` (grouped view). Requires at least one proxy API key to query models.
87
+
-**System**: quick links, update check, request logging toggle, local login data cleanup, and fetch `/v1/models` (grouped view). Requires at least one proxy API key to query models.
90
88
91
89
## Tech Stack
92
90
93
-
- React 19 + TypeScript 5.9
94
-
- Vite 7 (single-file build)
91
+
- React 19 + TypeScript 6.0
92
+
- Vite 8 (single-file build)
95
93
- Zustand (state management)
96
94
- Axios (HTTP client)
97
95
- react-router-dom v7 (HashRouter)
98
-
-Chart.js (data visualization)
96
+
-Motion (animations)
99
97
- CodeMirror 6 (YAML editor)
100
98
- SCSS Modules (styling)
101
99
- i18next (internationalization)
102
100
103
101
## Internationalization
104
102
105
-
Currently supports three languages:
103
+
Currently supports four languages:
106
104
107
105
- English (en)
108
106
- Simplified Chinese (zh-CN)
107
+
- Traditional Chinese (zh-TW)
109
108
- Russian (ru)
110
109
111
-
The UI language is automatically detected from browser settings and can be manually switched at the bottom of the page.
110
+
The UI language is automatically detected from browser settings and can be manually switched from the login page or header language menu.
112
111
113
112
## Browser Compatibility
114
113
@@ -120,7 +119,7 @@ The UI language is automatically detected from browser settings and can be manua
120
119
121
120
- Vite produces a **single HTML** output (`dist/index.html`) with all assets inlined (via `vite-plugin-singlefile`).
122
121
- Tagging `vX.Y.Z` triggers `.github/workflows/release.yml` to publish `dist/management.html`.
123
-
- The UI version shown in the footer is injected at build time (env `VERSION`, git tag, or `package.json` fallback).
122
+
- The UI version shown on the System page is injected at build time (env `VERSION`, git tag, or `package.json` fallback).
124
123
125
124
## Security notes
126
125
@@ -138,12 +137,12 @@ The UI language is automatically detected from browser settings and can be manua
138
137
## Development
139
138
140
139
```bash
141
-
npm run dev # Vite dev server
142
-
npm run build # tsc + Vite build
143
-
npm run preview # serve dist locally
144
-
npm run lint # ESLint (fails on warnings)
145
-
npm run format # Prettier
146
-
npm run type-check # tsc --noEmit
140
+
bun run dev # Vite dev server
141
+
bun run build # tsc + Vite build
142
+
bun run preview # serve dist locally
143
+
bun run lint # ESLint (fails on warnings)
144
+
bun run format # Prettier
145
+
bun run type-check # tsc --noEmit
147
146
```
148
147
149
148
## Contributing
@@ -152,7 +151,7 @@ Issues and PRs are welcome. Please include:
152
151
153
152
- Reproduction steps (server version + UI version)
154
153
- Screenshots for UI changes
155
-
- Verification notes (`npm run lint`, `npm run type-check`)
154
+
- Verification notes (`bun run lint`, `bun run type-check`, `bun run build`)
0 commit comments