{"_id":"orchestkit","name":"orchestkit","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"orchestkit","version":"0.1.0","description":"Official CLI for OrchestKit, install the Claude Code plugin, search and read the docs, and query the public docs API from your shell or a script.","homepage":"https://orchestkit.yonyon.ai/developers","type":"module","bin":{"orchestkit":"dist/cli.js","ork":"dist/cli.js"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./package.json":"./package.json"},"types":"./dist/index.d.ts","scripts":{"build":"tsc -p tsconfig.json && node scripts/chmod-bin.mjs","typecheck":"tsc --noEmit -p tsconfig.json","test":"vitest run","test:watch":"vitest","clean":"rm -rf dist","publish:dry-run":"npm pack --dry-run"},"engines":{"node":">=20.0.0"},"devDependencies":{"@types/node":"^26.2.0","typescript":"^7.0.2","vitest":"^4.1.10"},"keywords":["claude-code","orchestkit","yonyon","cli","agent","mcp","skills"],"author":{"name":"Yonatan Gross"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/yonatangross/orchestkit.git","directory":"packages/cli"},"bugs":{"url":"https://github.com/yonatangross/orchestkit/issues"},"publishConfig":{"access":"public"},"_id":"orchestkit@0.1.0","_nodeVersion":"26.7.0","_npmVersion":"11.19.0","dist":{"integrity":"sha512-CFaZe18DgVwmGEmxWhQK+Te+s2+vCnAqZ50fyl5zjeBHWXxGJdqkgJz8QAlawUrQ4BBzm6zKD+7LJzF1IkWh+Q==","shasum":"1281eb4d5f879f301f60a10d52357d11a10d5c96","tarball":"https://registry.npmjs.org/orchestkit/-/orchestkit-0.1.0.tgz","fileCount":27,"unpackedSize":54403,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDjFK6dg3DNZiyesSWvnLPt1y48Xp/JXsn1cpwWGGkkoQIhAKiA2AYSOmAlQY3oEthET5ayG5HkwnTxw6twJH8HnmcM"}]},"_npmUser":{"name":"yonatanhq","email":"yonatan2gross@gmail.com"},"directories":{},"maintainers":[{"name":"yonatanhq","email":"yonatan2gross@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/orchestkit_0.1.0_1787387790548_0.2883793488287032"},"_hasShrinkwrap":false}},"time":{"created":"2026-08-22T08:36:30.348Z","0.1.0":"2026-08-22T08:36:30.720Z","modified":"2026-08-22T08:36:30.965Z"},"maintainers":[{"name":"yonatanhq","email":"yonatan2gross@gmail.com"}],"description":"Official CLI for OrchestKit, install the Claude Code plugin, search and read the docs, and query the public docs API from your shell or a script.","homepage":"https://orchestkit.yonyon.ai/developers","keywords":["claude-code","orchestkit","yonyon","cli","agent","mcp","skills"],"repository":{"type":"git","url":"git+https://github.com/yonatangross/orchestkit.git","directory":"packages/cli"},"author":{"name":"Yonatan Gross"},"bugs":{"url":"https://github.com/yonatangross/orchestkit/issues"},"license":"MIT","readme":"# orchestkit\n\nOfficial CLI for [OrchestKit](https://orchestkit.yonyon.ai), the free,\nMIT-licensed Claude Code plugin published by the Yonyon software studio.\n\n> **Status: not yet published to npm.** The source lives here and the binary\n> builds and passes its suite, but `npm publish` has not been run. Do not\n> document `npx orchestkit` on the website until the first release is live:\n> a published-looking install command that 404s is worse than none.\n\n## What it does\n\nOrchestKit itself installs into Claude Code, not into your shell. This CLI is\nthe *scripting* surface around it: it prints the install command, emits MCP\nclient config, and queries the public read-only docs API from a terminal or a\nCI job without writing a fetch wrapper first.\n\n```\norchestkit install            # print the Claude Code install command\norchestkit search <query>     # search the documentation\norchestkit ask <question>     # natural-language query (NLWeb /ask)\norchestkit read <page>        # print a docs page as Markdown\norchestkit mcp [http|stdio]   # emit MCP client config\norchestkit doctor             # check Node, API reachability, rate-limit budget\n```\n\nOptions: `--limit <n>`, `--json`, `--base-url <url>` (or `ORCHESTKIT_BASE_URL`).\n\n## Examples\n\n```bash\norchestkit search \"parallel agents\" --limit 3\norchestkit read foundations/overview > overview.md\norchestkit mcp stdio > mcp.json\norchestkit search \"hooks\" --json | jq -r '.[].url'\n```\n\n## Library use\n\nThe same surface is importable, so a script can skip the shell:\n\n```ts\nimport { createClient, search } from \"orchestkit\";\n\nconst { results, rateLimit } = await search(createClient(), \"memory\", 5);\nconsole.log(results[0]?.url, `${rateLimit.remaining}/${rateLimit.limit} left`);\n```\n\n## API contract\n\nThe docs API is public, read-only and unauthenticated.\n\n- **Rate limits**, 120 requests per minute per IP per endpoint. Every response\n  carries the IETF `RateLimit-*` headers; the CLI surfaces the remaining budget\n  after each call so scripts can pace themselves instead of probing.\n- **Errors**, RFC 9457 Problem Details. `ApiError.problem` exposes the parsed\n  object, including the `links` recovery hops a 404 carries.\n- **Versioning and deprecation**, <https://orchestkit.yonyon.ai/api-policy>.\n\n## Requirements\n\nNode >= 20 (uses global `fetch`). Zero runtime dependencies.\n\n## Development\n\n```bash\nnpm run build        # tsc + shebang/exec-bit fixup\nnpm test             # unit suite + spawn tests against the built binary\nnpm run publish:dry-run\n```\n\n`npm test` spawns `dist/cli.js` for real, so run `npm run build` first or those\ncases skip. Networked commands are spawned with a preloaded `fetch` stub\n(`tests/fixtures/fetch-stub.mjs`), hermetic, no socket, no live site.\n\n## Releasing\n\n1. `npm run build && npm test && npm run publish:dry-run`\n2. `npm publish --access public` (name `orchestkit` was unregistered as of\n   2026-08-21; re-check before releasing)\n3. Only then: add the CLI to `DEVELOPER_RESOURCES` in\n   `docs/site/lib/developer-resources.ts` and to the package list in\n   `docs/site/app/llms.txt/route.ts`, so the site starts claiming it the day it\n   becomes true.\n\nMIT © Yonatan Gross\n","readmeFilename":"README.md","_rev":"1-dbead8d5375ec79cb71109030d5fc58c"}