pi-cliproxyapi-provider 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Richard Hao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,153 @@
+# pi-cliproxyapi-provider
+
+`pi-cliproxyapi-provider` registers one [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) instance as a pi model provider. It discovers models from CLIProxyAPI's OpenAI-compatible `/v1/models` endpoint and enriches them with metadata from [models.dev](https://models.dev/).
+
+## Install
+
+Install from npm:
+
+```bash
+pi install npm:pi-cliproxyapi-provider
+```
+
+Or install from GitHub:
+
+```bash
+pi install git:github.com/0xRichardH/pi-cliproxyapi-provider@master
+```
+
+You can omit `@master`, but pinning a branch, tag, or commit makes Git installs reproducible:
+
+```bash
+pi install git:github.com/0xRichardH/pi-cliproxyapi-provider@a28f326
+```
+
+Restart pi after installing, then run:
+
+```text
+/cliproxyapi config
+/login cpa
+/model
+```
+
+## Install for local testing
+
+From this repository:
+
+```bash
+pi -e .
+```
+
+List models without installing:
+
+```bash
+CLIPROXYAPI_BASE_URL=http://localhost:8317/v1 \
+CLIPROXYAPI_API_KEY=your-key \
+pi -e . --list-models cpa
+```
+
+## Configure
+
+Run the interactive command:
+
+```text
+/cliproxyapi config
+```
+
+It writes global connection/auth config to:
+
+```text
+~/.pi/agent/pi-cliproxyapi-provider/config.json
+```
+
+Environment variables override config:
+
+```text
+CLIPROXYAPI_BASE_URL
+CLIPROXYAPI_PROVIDER_NAME
+CLIPROXYAPI_AUTH_REQUIRED
+CLIPROXYAPI_AUTH_HEADER
+CLIPROXYAPI_MODELS_DEV_ENABLED
+```
+
+Project config only supports metadata aliases. Connection and auth settings such as `baseUrl`, `providerName`, `authRequired`, `authHeader`, and `headers` must be set in global config or environment variables.
+
+## Authenticate
+
+Use pi's normal API-key login flow:
+
+```text
+/login cpa
+```
+
+If you changed the provider name, use that name instead:
+
+```text
+/login 0xdev
+```
+
+For non-interactive runs, set:
+
+```bash
+export CLIPROXYAPI_API_KEY=your-key
+```
+
+## Commands
+
+```text
+/cliproxyapi config   # interactive setup
+/cliproxyapi status   # show config, cache ages, and enrichment counts
+/cliproxyapi refresh  # refresh caches, then run /reload
+/cliproxyapi aliases  # show unmatched model IDs for metadata aliases
+```
+
+## Metadata aliases
+
+Aliases affect metadata only. The package still sends the original CLIProxyAPI model ID to the proxy.
+
+Add global aliases to:
+
+```text
+~/.pi/agent/pi-cliproxyapi-provider/config.json
+```
+
+Add project aliases manually to:
+
+```text
+.pi/pi-cliproxyapi-provider/config.json
+```
+
+Project config only reads `modelAliases`; other fields are ignored.
+
+```json
+{
+  "modelAliases": {
+    "claude-opus-4-6-thinking": "anthropic/claude-opus-4-6"
+  }
+}
+```
+
+## Caches
+
+```text
+CPA /v1/models cache: 1 hour
+models.dev cache:    1 day
+```
+
+Caches live under:
+
+```text
+~/.cache/pi-cliproxyapi-provider/
+```
+
+Startup does not fetch `models.dev`. It uses a fresh local `models.dev` cache when present, otherwise it uses `data/models-dev-fallback.json`. Run `/cliproxyapi refresh` to update both the CPA model cache and the `models.dev` metadata cache.
+
+## Test
+
+```bash
+npm test
+```
+
+## Release
+
+Releases are published to npm when a matching `v*` tag is pushed. See [RELEASING.md](RELEASING.md) for npm authentication, first-release steps, versioning, verification, and troubleshooting.