This guide walks you from zero to a running CLIProxyAPI instance managed by the tray application. You will install the tray, set a password, let the tray download CLIProxyAPI automatically, and open the management WebUI — all in under five minutes.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.
Install CLIProxyAPI Tray
Open PowerShell (Windows PowerShell 5.1 or PowerShell 7) and run:The installer downloads the application files to
%USERPROFILE%\.cli-proxy-api-tray and places a CLIProxyAPI Tray shortcut on your desktop. For alternative install options, see Installation.Launch the tray
Double-click the CLIProxyAPI Tray desktop shortcut. No console window appears. After a moment, the CLIProxyAPI Tray icon appears in the Windows taskbar notification area (system tray).
If the icon does not appear immediately, check the hidden icons area (the
^ arrow in the taskbar). You can drag the icon to the visible area to keep it accessible.Set your password
On first run, if
config.yaml does not contain a secret-key, a dialog prompts you to enter a password. Type a password and click OK. The tray saves it as secret-key in config.yaml. This key is required to access the CLIProxyAPI management API and WebUI.If you see the password prompt repeatedly, check that
config.yaml is writable by your user account. See Password management for details.CLIProxyAPI downloads automatically
If no CLIProxyAPI binary is installed yet, a dialog asks whether you want to download the latest version. Click Yes. A progress window shows the download from GitHub Releases. The binary is saved to the
versions/ directory inside the install folder.Download requires access to GitHub Releases. If you are on a corporate network, check your proxy or firewall settings if the download fails.
Service starts
After the download completes, CLIProxyAPI starts automatically. The tray icon tooltip changes to CLIProxyAPI Tray - Running, confirming the service is up.
What’s next
Tray menu
Learn every tray menu item and what each action does
config.yaml reference
Change the port, API keys, TLS, and other proxy settings
Auto update
Keep CLIProxyAPI up to date automatically on tray startup
FAQ
Troubleshoot common issues with the tray and the service