The tray icon sits in the Windows taskbar notification area. Right-click it to open the context menu. This page documents every menu item and its behavior.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/kitephp/CLIProxyAPI-Tray/llms.txt
Use this file to discover all available pages before exploring further.
Menu items
The context menu is built in a fixed order each time the tray starts. The items below are listed from top to bottom as they appear in the menu.Status display
Running (vX.Y.Z) / Not Running A read-only label at the top of the menu (always grayed out, not clickable). When CLIProxyAPI is running, it shows the installed CLIProxyAPI version tag — for example,Running (v6.7.37). When stopped, it shows Not Running.
Service controls
Start is only enabled when the service is not running. Restart and Stop are only enabled when the service is running.
| Menu item | Enabled when | Action |
|---|---|---|
| Start | Not running | Starts the CLIProxyAPI process |
| Restart | Running | Stops then starts CLIProxyAPI |
| Stop | Running | Kills the CLIProxyAPI process |
Open submenu
The Open submenu provides shortcuts to commonly used destinations.| Submenu item | Enabled when | Action |
|---|---|---|
| WebUI | Running | Opens http://127.0.0.1:{port}/management.html in the default browser |
| Folder | Always | Opens the CLIProxyAPI Tray install directory in Windows Explorer |
| Config | config.yaml exists | Opens config.yaml in the system default editor |
Open → WebUI checks whether the port is accepting connections before opening the browser. If the port is not listening, a balloon tip shows “Not running (port not listening)” instead.
Settings submenu
The Settings submenu contains toggles and configuration actions that persist across sessions.Auto Open WebUI
A checkable toggle menu item. When checked, the WebUI opens automatically after:- Clicking Start (1-second delay after the service starts)
- Clicking Restart
- Update installing a new version and restarting
- Tray startup when CLIProxyAPI is already running
autoOpenWebUI: true in settings.json).
Auto Open WebUI affects automatic opens only — manual WebUI opens via Open → WebUI or tray double-click are always available regardless of this setting.
Auto Update
A checkable toggle menu item. When checked, the tray silently checks GitHub for the latest CLIProxyAPI release every time the tray application starts. If a newer version is found, it downloads and installs without a confirmation dialog. Default state: OFF (autoUpdate: false in settings.json).
Auto Update does not run on a background timer — it only checks at tray startup. You can always trigger a manual update via the Update menu item.
Reset Password
Prompts for a new password using a dialog box, then writes the entered value assecret-key under remote-management in config.yaml. A balloon tip confirms success or failure.
Update
Checks GitHub (repository:router-for-me/CLIProxyAPI) for the latest release.
- If already on the latest version: shows a “Already latest: vX.Y.Z” balloon tip.
- If a newer version is available: shows a dialog with the version information and asks for confirmation before downloading and installing.
- After a successful install: starts the new version automatically.
About
Openshttps://github.com/kitephp/CLIProxyAPI-Tray in the default browser.
Exit
Stops the CLIProxyAPI process, hides the tray icon, stops the internal update timer, and exits the application viaApplication.Exit().
Double-click behavior
Double-clicking the tray icon triggers one of two actions depending on the current service state:| Service state | Double-click action |
|---|---|
| Running | Opens the WebUI (same check as Open → WebUI) |
| Not running | Starts the service (same as clicking Start) |
Tray tooltip
The tooltip text shown when you hover over the tray icon reflects the current service state:| State | Tooltip text |
|---|---|
| Stopped | CLIProxyAPI Tray |
| Running | CLIProxyAPI Tray - Running |