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 Tray can be installed in two ways. The one-line installer is the fastest path — it downloads the latest files and creates a desktop shortcut in one command. The clone method is better if you want to track changes through git or contribute to the project.
1

Open PowerShell

Open Windows PowerShell 5.1 (search for “Windows PowerShell” in the Start menu) or PowerShell 7 (pwsh). Either version works.
2

Run the installer

Paste and run the following command:
irm https://raw.githubusercontent.com/kitephp/CLIProxyAPI-Tray/main/install.ps1 | iex
The installer downloads the latest files from the main branch, copies them to the install directory, and creates a desktop shortcut named CLIProxyAPI Tray.
3

Check the install directory

The default install location is:
%USERPROFILE%\.cli-proxy-api-tray
You can open this folder in Explorer to confirm the files are present.
4

Use the desktop shortcut

A shortcut named CLIProxyAPI Tray is placed on your desktop. Double-click it to launch the tray application. See Get started for what happens on first launch.
The installer never overwrites an existing config.yaml, settings.json, versions/, or logs/ directory. Re-running the installer is safe and updates only the application scripts.

Installer parameters

When using Method A, you can pass parameters to install.ps1 to customise the installation. The table below lists all available parameters.
ParameterTypeDefaultDescription
-InstallDirstring%USERPROFILE%\.cli-proxy-api-trayOverride the install location. Accepts any absolute path.
-ShortcutShellAuto | WindowsPowerShell | PowerShell7AutoShell used by the desktop shortcut. Auto prefers pwsh.exe if it is found on PATH, otherwise falls back to Windows PowerShell.
-NoShortcutswitchoffSkip creating the desktop shortcut.
-BranchstringmainBranch to install from. Useful for testing pre-release branches.
Example — install to a custom directory and force the PowerShell 7 shortcut:
irm https://raw.githubusercontent.com/kitephp/CLIProxyAPI-Tray/main/install.ps1 | iex -Args "-InstallDir C:\Tools\CLIProxyAPITray -ShortcutShell PowerShell7"

How the launcher works

The desktop shortcut does not call powershell.exe or pwsh.exe directly. Instead it calls wscript.exe with cli-proxy-api.vbs as the target. The VBScript launcher:
  1. Looks for pwsh.exe on PATH and in the default PowerShell 7 install locations.
  2. Falls back to %SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe if pwsh.exe is not found.
  3. Runs cli-proxy-api.ps1 with -STA -NoProfile -WindowStyle Hidden -ExecutionPolicy Bypass.
The -WindowStyle Hidden flag means no console window appears when you launch the tray. Everything happens silently in the background, with the tray icon as the only visible surface.

Build docs developers (and LLMs) love