{"id":51621176,"url":"https://github.com/gonkagate/zeroclaw-setup","last_synced_at":"2026-07-12T20:00:58.968Z","repository":{"id":366908739,"uuid":"1213474572","full_name":"GonkaGate/zeroclaw-setup","owner":"GonkaGate","description":"Install GonkaGate for ZeroClaw with one npx command. Setup and verify CLI for custom OpenAI-compatible provider config, live model checks, and hidden API key setup.","archived":false,"fork":false,"pushed_at":"2026-07-06T23:31:40.000Z","size":427,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-07-07T01:10:59.599Z","etag":null,"topics":["ai-cli","ai-coding","ai-models","api-key","cli","coding-agent","custom-provider","developer-tools","gonkagate","llm","model-checks","npx","openai-api","openai-compatible","secure-setup","typescript","verification","zeroclaw","zeroclaw-setup"],"latest_commit_sha":null,"homepage":"https://gonkagate.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GonkaGate.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/security.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-04-17T12:22:27.000Z","updated_at":"2026-07-06T23:31:35.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/GonkaGate/zeroclaw-setup","commit_stats":null,"previous_names":["gonkagate/zeroclaw-setup"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/GonkaGate/zeroclaw-setup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GonkaGate%2Fzeroclaw-setup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GonkaGate%2Fzeroclaw-setup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GonkaGate%2Fzeroclaw-setup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GonkaGate%2Fzeroclaw-setup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GonkaGate","download_url":"https://codeload.github.com/GonkaGate/zeroclaw-setup/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GonkaGate%2Fzeroclaw-setup/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35401732,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-12T02:00:06.386Z","response_time":87,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-cli","ai-coding","ai-models","api-key","cli","coding-agent","custom-provider","developer-tools","gonkagate","llm","model-checks","npx","openai-api","openai-compatible","secure-setup","typescript","verification","zeroclaw","zeroclaw-setup"],"created_at":"2026-07-12T20:00:56.838Z","updated_at":"2026-07-12T20:00:58.952Z","avatar_url":"https://github.com/GonkaGate.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zeroclaw-setup\n\nSet up local ZeroClaw to use GonkaGate in one `npx` command.\n\n```bash\nnpx zeroclaw-setup\n```\n\n![Package](https://img.shields.io/badge/package-zeroclaw--setup-6E63FF?style=flat-square)\n![Node](https://img.shields.io/badge/node-%3E%3D22.14.0-4DA2FF?style=flat-square)\n![ZeroClaw](https://img.shields.io/badge/ZeroClaw-v0.6.9-35D6FF?style=flat-square)\n![License](https://img.shields.io/badge/license-Apache--2.0-2A2A2A?style=flat-square)\n\n[![Website](https://img.shields.io/badge/Website-gonkagate.com-111827?style=flat-square)](https://gonkagate.com/en?utm_source=github\u0026utm_medium=referral\u0026utm_campaign=zeroclaw_setup\u0026utm_content=readme_badge_website)\n[![Docs](https://img.shields.io/badge/Docs-API%20Guides-2563EB?style=flat-square)](https://gonkagate.com/en/docs?utm_source=github\u0026utm_medium=referral\u0026utm_campaign=zeroclaw_setup\u0026utm_content=readme_badge_docs)\n[![API%20Key](https://img.shields.io/badge/API%20Key-Dashboard-F97316?style=flat-square)](https://gonkagate.com/en/register?utm_source=github\u0026utm_medium=referral\u0026utm_campaign=zeroclaw_setup\u0026utm_content=readme_badge_api_key)\n[![Telegram](https://img.shields.io/badge/Telegram-%40gonkagate-229ED9?style=flat-square\u0026logo=telegram\u0026logoColor=white)](https://t.me/gonkagate)\n[![X](https://img.shields.io/badge/X-%40gonkagate-000000?style=flat-square\u0026logo=x\u0026logoColor=white)](https://x.com/gonkagate)\n[![LinkedIn](https://img.shields.io/badge/LinkedIn-GonkaGate-0A66C2?style=flat-square\u0026logo=linkedin\u0026logoColor=white)](https://www.linkedin.com/company/gonkagate)\n\n## Overview\n\nOnboarding-first ZeroClaw utility for configuring GonkaGate as the primary\ncustom provider.\n\nThe repository is still intentionally narrow: it owns only the GonkaGate\nprovider contract, delegates persistence to ZeroClaw-native seams, and stays\non the audited stable ZeroClaw `v0.6.9` config contract.\n\nFollow-up verification command:\n\n```bash\nnpx zeroclaw-setup verify\n```\n\nCurrent status:\n\n- repository infrastructure is ready for active development and publishing\n- install now performs real Phase 2 mutation work on audited ZeroClaw\n  `v0.6.9`\n- first-run setup uses a proven two-step native path:\n  `zeroclaw onboard --quick --provider custom:https://api.gonkagate.com/v1 --model \u003cmodel-id\u003e`\n  followed by the hidden native `zeroclaw props set api-key` prompt\n- first-run mutation stays intentionally limited to that hidden native prompt\n  path; stdin-fed secret transport remains blocked because it is not part of\n  the shipped proof on audited `v0.6.9`\n- existing-config updates use a split native write seam:\n  `default-provider` and `default-model` go through\n  `zeroclaw props set --no-interactive`, while `api-key` stays on the hidden\n  native `zeroclaw props set api-key` path\n- after hidden GonkaGate key entry, install calls\n  `GET https://api.gonkagate.com/v1/models`, validates the response shape, and\n  uses the returned live model IDs for model prompts, `--model` validation, and\n  ZeroClaw config mutation\n- empty or malformed live model catalogs block setup before any ZeroClaw config\n  mutation\n- install refuses mutation when the runtime is active or ambiguous, when the\n  config contains unknown top-level keys, or when the installed ZeroClaw\n  runtime is missing, unparseable, or older than `v0.6.9`\n- `verify` now performs the shipped Phase 3 read-only verdict flow: minimum\n  version gating, active config resolution, saved-config\n  contract checks, runtime summary through `zeroclaw status`, and advisory\n  `zeroclaw doctor` output\n- `verify` returns explicit `pass`, `warn-shadowed`, and `fail` results, with\n  the exact warning `saved config is correct but inactive` when env overrides\n  shadow an otherwise-correct saved GonkaGate contract\n\n## Quick Start\n\n```bash\nnpm install\nnpm run ci\nnpm run dev -- --help\n```\n\nDevelopment entrypoints:\n\n- `npm run dev`\n- `npm run dev -- verify`\n- `npm run build`\n- `npm run lint`\n- `npm test`\n- `npm run ci`\n\n## What Is Already Set Up\n\n- TypeScript ESM project structure with separate typecheck and build configs\n- ESLint + Prettier wired into local scripts and CI\n- packaged CLI binary at `zeroclaw-setup`\n- GitHub Actions for CI, release-please, and npm publish\n- release metadata files aligned with sibling `*-setup` repositories\n- mirrored `.agents` and `.claude` skill packs copied from `opencode-setup`\n- starter docs under `docs/`\n- node:test coverage for version gating, config resolution, first-run proof,\n  native write sequencing, restore boundaries, live model catalog, docs, and\n  package metadata\n\n## Repository Layout\n\n```text\nbin/                    packaged CLI entrypoint\ndocs/                   docs, security notes, implementation plan, specs mirror\nscripts/                repository utility scripts\nsrc/constants/          fixed provider data\nsrc/install/            install and verify runtime seams\ntest/                   fast node:test coverage for install, verify, and repo contracts\n.agents/skills/         mirrored local skill pack for agent workflows\n.claude/skills/         mirrored local skill pack for Claude-compatible workflows\n```\n\n## Product Contract Seeded In Code\n\nThe code hard-codes the GonkaGate contract from the PRD:\n\n- provider base URL: `https://api.gonkagate.com/v1`\n- provider key: `custom:https://api.gonkagate.com/v1`\n- managed config fields:\n  - `default_provider`\n  - `api_key`\n  - `default_model`\n- shipped first-run path:\n  - `zeroclaw onboard --quick --provider custom:https://api.gonkagate.com/v1 --model \u003cmodel-id\u003e`\n  - hidden native `zeroclaw props set api-key`\n  - first-run mutation stays blocked when the API key would need stdin or\n    another unproven transport\n- shipped existing-config path:\n  - `zeroclaw props set --no-interactive default-provider custom:https://api.gonkagate.com/v1`\n  - `zeroclaw props set --no-interactive default-model \u003cmodel-id\u003e`\n  - hidden native `zeroclaw props set api-key`\n  - runtime-quiesced sequencing with non-secret restore after pre-secret and\n    post-secret failures\n  - explicit secret remediation because stable native read-back does not expose\n    the prior `api-key`\n  - saved-config confirmation uses `api_key` set/unset evidence only; literal\n    secret read-back is not part of the wrapper contract\n- chosen v1 verify shadowing behavior:\n  - explicit `saved config is correct but inactive` warning when env overrides\n    mask the saved GonkaGate contract\n- shipped verify evidence split:\n  - `zeroclaw status` informs the effective runtime verdict\n  - `zeroclaw doctor` remains advisory troubleshooting context\n- live model catalog gate:\n  - endpoint: `GET https://api.gonkagate.com/v1/models`\n  - auth: `Authorization: Bearer \u003cgp-...\u003e`\n  - response trust boundary: root object with a `data` array of objects whose\n    `id` fields are non-empty strings and optional string `name` fields\n  - duplicate live model IDs are deduped\n  - install fails cleanly on empty or malformed live catalogs before model\n    selection or native writes\n  - the selected live model ID is written directly to `default_model`\n- public install flag surface:\n  - optional `--model \u003cid\u003e` validated against the fetched live catalog\n- env override checks:\n  - `ZEROCLAW_PROVIDER`\n  - `ZEROCLAW_MODEL_PROVIDER`\n  - `MODEL_PROVIDER`\n  - `PROVIDER`\n  - `ZEROCLAW_MODEL`\n  - `MODEL`\n  - `ZEROCLAW_API_KEY`\n  - `API_KEY`\n- ZeroClaw runtime gate:\n  - minimum supported version: audited stable ZeroClaw `v0.6.9`\n  - newer versions are not blocked solely because they are newer\n\n## CLI Status\n\nThe package exposes these public commands:\n\n```bash\nnpx zeroclaw-setup\nnpx zeroclaw-setup verify\n```\n\nCurrent shipped behavior:\n\n- `npx zeroclaw-setup` performs real Phase 2 install mutation when the\n  installed ZeroClaw runtime is at least audited `v0.6.9` and read-only gating\n  passes\n- install asks for a hidden GonkaGate API key after the chosen mutation path is\n  known and the runtime quiesce gate has passed, checks the live\n  `GET /v1/models` catalog, then prompts for a live model when `--model` is\n  omitted in an interactive terminal\n- non-interactive/default installs without `--model` use the first valid live\n  model returned by `/v1/models`\n- the wrapper-collected key is used for the live catalog check; public native\n  storage paths still let ZeroClaw collect the persisted `api-key` through\n  `zeroclaw props set api-key`, so first-run stdin secret persistence remains\n  blocked\n- first-run install is shipped only when ZeroClaw can collect the secret\n  through its hidden native `zeroclaw props set api-key` prompt\n- install does not place the GonkaGate API key on argv in the shipped happy\n  path\n- `npx zeroclaw-setup verify` now performs shipped read-only verification,\n  including final `pass` / `warn-shadowed` / `fail` verdicts\n- verify and saved-config confirmation use `api_key` set/unset evidence only;\n  they do not claim literal saved secret read-back\n\n## Docs\n\n- [docs/README.md](docs/README.md) current-truth documentation index\n- [docs/how-it-works.md](docs/how-it-works.md)\n- [docs/implementation-plan.md](docs/implementation-plan.md) historical\n  execution record\n- [docs/prd-task-breakdown.md](docs/prd-task-breakdown.md) historical planning\n  checklist\n- [docs/security.md](docs/security.md)\n- [docs/troubleshooting.md](docs/troubleshooting.md)\n- [docs/specs/zeroclaw-setup-prd/spec.md](docs/specs/zeroclaw-setup-prd/spec.md)\n\n## Release Flow\n\nThe repository follows the same release automation pattern as neighboring\nGonkaGate CLI utilities:\n\n1. `CI` runs on push and pull request\n2. `Release Please` opens and updates release PRs from conventional commits\n3. tags dispatch `Publish (npm)` with OIDC-based provenance publishing\n\n## License\n\nApache-2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgonkagate%2Fzeroclaw-setup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgonkagate%2Fzeroclaw-setup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgonkagate%2Fzeroclaw-setup/lists"}