Skip to main content

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.

CLIProxyAPI includes a built-in web management panel (WebUI) served at http://127.0.0.1:{port}/management.html. CLIProxyAPI Tray provides shortcuts to open it automatically or on demand.

​
Ways to open the WebUI

Double-click the tray icon

Double-click the CLIProxyAPI Tray icon in the taskbar notification area. Only works when the service is running — double-clicking while stopped starts the service instead.

Tray menu shortcut

Right-click the tray icon, then select Open → WebUI. This menu item is only enabled when the service is running.

Direct browser URL

Navigate directly in any browser to http://127.0.0.1:8317/management.html (replace 8317 with your configured port).

​
Before the WebUI opens

Before opening the browser, the tray checks whether the port is accepting TCP connections (with a 500 ms timeout).
  • Port is listening: Opens http://127.0.0.1:{port}/management.html in the default browser.
  • Port is not listening: Shows a “Not running (port not listening)” balloon tip instead of opening the browser.
This check applies to both the Open → WebUI menu item and the tray icon double-click (when the service is already running).

​
Auto Open WebUI setting

The Auto Open WebUI setting controls whether the tray automatically opens the WebUI after certain events. Toggle it via Settings → Auto Open WebUI in the tray menu. The setting is stored in settings.json as autoOpenWebUI. Default: ON
The WebUI opens automatically after:
  • Clicking Start — opens 1 second after the service starts
  • Clicking Restart — opens after the restarted service is ready
  • Update installing a new version and restarting the service
  • Tray startup when CLIProxyAPI is already running
Auto Open WebUI only controls automatic opens. Manual access via the menu or double-click is always available regardless of this setting.

​
Direct URL access

You can always open the WebUI directly in any browser without using the tray: 
http://127.0.0.1:8317/management.html
If you have changed the default port, find your configured value in config.yaml: 
port: 8317
The tray reads the port from config.yaml each time it opens the WebUI URL, so changes to the port take effect immediately without restarting the tray.
The WebUI is served by CLIProxyAPI itself — the tray only opens a browser window pointing to the local address. The tray does not host or proxy the WebUI in any way.

Build docs developers (and LLMs) love

Get started for freeTalk to us