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 saves its state and preferences to settings.json. This file tracks the installed CLIProxyAPI version, system architecture, and toggle settings. It is managed automatically — you rarely need to edit it directly.

File location

The tray resolves settings.json using a primary path with an automatic fallback.
PriorityPath
Primary<script directory>\settings.json
Fallback%LOCALAPPDATA%\CLIProxyAPI_Tray\settings.json
The tray tries the primary location first. If the script directory is not writable (for example, when installed under Program Files), it automatically writes to the fallback path instead. A balloon tip warns you when this happens.

Reading logic

On startup, the tray reads both the primary and fallback locations (if they exist) and uses the file with the most recent LastWriteTimeUtc. This ensures the most up-to-date settings are always loaded, regardless of which path was last written to.

Fields

{
  "version": "v6.7.37",
  "arch": "amd64",
  "autoOpenWebUI": true,
  "autoUpdate": false,
  "updatedAt": "2024-12-01T10:30:00.0000000+00:00"
}
FieldTypeDefaultDescription
versionstringnullThe installed CLIProxyAPI version tag, e.g. "v6.7.37". Used to locate the binary at versions/{version}/cli-proxy-api.exe.
archstringdetectedSystem architecture: "amd64" or "arm64". Detected automatically at runtime.
autoOpenWebUIbooleantrueWhen true, the WebUI opens automatically after Start, Restart, and Update. Also opens on tray startup if CLIProxyAPI is already running.
autoUpdatebooleanfalseWhen true, the tray checks for a newer CLIProxyAPI release on every tray startup and installs it without a confirmation dialog.
updatedAtstringISO 8601 timestamp of the last save. Written automatically — do not edit this manually.

Legacy field cleanup

Any fields from older versions of settings.json that are no longer recognized are automatically removed the next time the tray saves state. You do not need to clean up old files manually.
Do not manually set version to a tag that does not exist in the versions/ directory. If the binary is missing, the tray will prompt you to download it again before starting the service.

Build docs developers (and LLMs) love