Summary

This project delivers a single-file React/TypeScript WebUI for the CLI Proxy API, streamlining configuration, monitoring, and troubleshooting. It targets CLI Proxy API users seeking an intuitive graphical interface for managing settings, credentials, logs, and usage, abstracting complex API interactions.

How It Works

The WebUI functions as a client to the CLI Proxy API's Management API (/v0/management). Built with React and TypeScript, it translates API endpoints into a user-friendly dashboard for tasks like configuration updates, API key management, credential uploads, log inspection, and usage analytics. Its core advantage lies in simplifying complex backend operations through a visual interface.

Quick Start & Requirements

• Installation/Run:
  • Bundled (Recommended): Start the CLI Proxy API service (v≥6.3.0, rec. v≥6.5.0) and access http://<host>:<api_port>/management.html.
  • Development: Clone repo, npm install, npm run dev for local server at http://localhost:5173.
  • Standalone Build: npm install, npm run build generates dist/index.html with inlined assets.
• Prerequisites: Node.js/npm for development/build. Running CLI Proxy API service for bundled access.
• Links:
  • Main Project: https://github.com/router-for-me/CLIProxyAPI
  • Example URL: https://remote.router.for.me/

Highlighted Details

• Vite-powered single-file HTML build (dist/index.html) with all assets inlined via vite-plugin-singlefile.
• Comprehensive management: Dashboard, Basic Settings, API Keys, AI Providers (Gemini, Codex, Claude, OpenAI-compatible), Auth Files, OAuth, Usage analytics, Config editing, Log tailing.
• Remote management support requires server-side allow-remote-management: true configuration.
• Management key obfuscated in browser localStorage (enc::v1::...) for enhanced security.

Maintenance & Community

No specific contributor, sponsorship, or community channel details are provided beyond a general invitation for issues and PRs. Development includes linting (npm run lint) and type-checking (npm run type-check).

Licensing & Compatibility

• License: MIT.
• Compatibility: Permissive MIT license supports commercial use and integration with closed-source projects.

Limitations & Caveats

UI functionality is dependent on the backend CLI Proxy API version and enabled features; older versions or disabled endpoints may result in "unsupported" feature displays. Browser-based tests are subject to client-side network and CORS restrictions. Remote management requires explicit server configuration and carries inherent security considerations.