@gonkagate/pi-setup
v0.4.0
Published
Configure Pi Coding Agent to use GonkaGate as an OpenAI-compatible custom provider.
Maintainers
Readme
@gonkagate/pi-setup
Configure Pi Coding Agent to use GonkaGate as an OpenAI-compatible custom
provider with one npx command.
npx -y @gonkagate/pi-setup@latest
@gonkagate/pi-setup is the onboarding CLI for developers who use Pi Coding
Agent and want to route models through the GonkaGate API without hand-editing
Pi's provider, auth, or default-model config.
What It Does
- Writes a
providers.gonkagateentry to~/.pi/agent/models.json. - Preserves unrelated Pi providers and top-level config.
- Reads your API key from
GONKAGATE_API_KEY,--api-key-stdin, or a hidden prompt. - Fetches the current GonkaGate model list from
/v1/modelsusing that API key. - Shows an arrow-key model picker in interactive terminals.
- Writes a Pi-compatible
gonkagateAPI-key entry to~/.pi/agent/auth.json. - Sets
defaultProvideranddefaultModelin~/.pi/agent/settings.json. - Creates sibling backups before replacing existing managed files.
- Installs the fetched GonkaGate model list for Pi Coding Agent.
- Does not accept a plain
--api-keyflag and never printsgp-...keys.
Setup success means configured: GonkaGate config and Pi auth/default settings
were written or already matched. It does not mean verified; default setup only
calls /v1/models for model metadata and does not verify a live Pi chat
session.
Quick Start
npx -y @gonkagate/pi-setup@latest
piFor automation, avoid shell history by using stdin:
printf '%s' "$GONKAGATE_API_KEY" | npx -y @gonkagate/pi-setup@latest --yes --api-key-stdinPreview the generated config without writing:
npx -y @gonkagate/pi-setup@latest --dry-runDry runs still need an API-key source because model choices come from
/v1/models.
Use a custom config path during testing:
npx -y @gonkagate/pi-setup@latest --config ./models.jsonRestore from a backup by copying the generated models.json.backup-* file back
over ~/.pi/agent/models.json. Auth and settings backups use the same sibling
pattern beside auth.json and settings.json.
Limits
The setup only makes the /v1/models metadata request. It does not mutate shell
profiles, generate .env files, accept --api-key, support arbitrary custom
base URLs, support arbitrary custom model ids outside /v1/models, claim
concurrent-writer safety, or run default live GonkaGate/Pi verification.
Deferred features require the evidence gates in
docs/specs/pi-setup-prd/spec.md before
implementation.
Platform Proof
CI is configured for Ubuntu and native Windows. WSL remains a manual smoke target; do not claim WSL-specific proof until the checklist in the PRD has been run inside WSL.
Development
npm install
npm run ciRelease Please opens release PRs only from Conventional Commits on main.
Use feat: ... for user-facing setup behavior and fix: ... for user-facing
bug fixes. When squash-merging, make the squash title conventional;
[codex] ... and plain titles will not trigger an npm release.
Product requirements live in
docs/specs/pi-setup-prd/spec.md.
The package is intentionally small. It configures Pi's documented custom provider, API-key auth, and default-model settings surfaces.
