--- name: api2cli description: "Generate or discover a CLI + AgentSkill for any REST API. Use when: user says 'create a CLI for X', 'wrap this API', 'search if a CLI exists', 'install an existing CLI', 'make a skill for X', 'publish my CLI', 'publish to npm', 'push to github'. Handles registry search, install, discovery, scaffolding, resource implementation, building, linking, skill generation, npm publishing, and GitHub publishing." --- # api2cli Turn any REST API into a standardized, agent-ready CLI. Always use `npx api2cli` to run commands. Always use `--json` when calling generated CLIs programmatically. ## Prerequisites ```bash bun --version || curl -fsSL https://bun.sh/install | bash ``` ## Workflow Follow all steps in order — do not skip any. ### 1. Search the registry first Before generating anything, check if a CLI already exists: ```bash npx api2cli search ``` If the registry already has the CLI you need, install it instead of rebuilding it: ```bash npx api2cli install ``` See [references/commands.md](references/commands.md) for filters like `--type`, `--category`, and `--json`. ### 2. Discover the API Find the API docs or OpenAPI spec. Identify: base URL, auth type, auth header, all resources and endpoints. ### 3. Create the scaffold ```bash npx api2cli create --base-url --auth-type bearer ``` See [references/create.md](references/create.md) for all flags and what gets generated. ### 4. Implement resources Create `~/.cli/-cli/src/resources/.ts` for each API resource. Register in `src/index.ts`. See [references/resource-patterns.md](references/resource-patterns.md) for the CRUD template and library API. ### 5. Build, link, and test ```bash npx api2cli bundle npx api2cli link -cli --help -cli list --json ``` `api2cli link` adds `~/.local/bin` to PATH automatically. No `export PATH` needed. ### 6. Finalize skill and README **This step is mandatory.** The skill must become a real operating guide for another agent, not just a command list — no placeholders, no TODOs. 1. **Introspect the CLI**: run `-cli --help`, then ` --help` and ` --help` for every resource and action 2. **Update the description**: list all resource names and add domain-specific trigger phrases 3. **Set the category**: replace `{{CATEGORY}}` with the correct value (e.g. `social-media`, `email`, `devtools`) 4. **Write the task-oriented sections**: replace `{{WHEN_TO_USE_HELP}}`, `{{CAPABILITIES_HELP}}`, and `{{USE_CASES_HELP}}` with domain-specific guidance 5. **Build resource tables**: for each resource, create a command table with every action and its real flags (from `--help` output) 6. **Add Quick Reference + Output Format**: include `--help` commands and document the JSON envelope 7. **Remove all placeholders**: no `{{...}}` or `` should remain 8. **Validate**: run at least one command to confirm the skill's examples are accurate See [references/skill-generation.md](references/skill-generation.md) for the full introspection workflow, format, quality checklist, and symlink instructions. To also link skills for OpenClaw: ```bash npx api2cli link --openclaw ``` See [references/openclaw.md](references/openclaw.md) for the one-prompt setup, ClawHub publishing, API key auto-detection, and custom `--skills-path` usage. Also available on ClawHub: `npx clawhub install api2cli` ### 7. Publish (when user asks) Before any publish target, run these pre-flight checks: 1. **Verify `gh` CLI is authenticated**: run `gh auth status`. If not logged in, ask the user to run `gh auth login` first. **Stop and wait.** 2. **Check if the CLI is already on GitHub**: run `git remote get-url origin` in the CLI directory. - If no remote exists → the CLI is not on GitHub yet. **Automatically run the GitHub publish flow first** (see below) before proceeding to npm or registry publish. - If a remote exists → already on GitHub, continue. #### To GitHub Push the CLI to a public GitHub repo. See [references/publish-to-github.md](references/publish-to-github.md) for pre-flight checks, repo creation, and push workflow. #### To npm Requires the CLI to be on GitHub first (for `repository` field in package.json). If not on GitHub, run the GitHub publish flow above first. Publish the CLI to the npm registry so users can `npm i -g ` or `npx `. See [references/publish-to-npm.md](references/publish-to-npm.md) for auth, package.json validation, build, verify, and publish workflow. Also see [references/package-checklist.md](references/package-checklist.md) for the field-by-field package.json reference. #### To ClawHub Publish the generated skill to ClawHub so OpenClaw users can discover and install it. 1. **Auth**: run `npx clawhub login`. If not authenticated, ask the user to complete login first. **Stop and wait.** 2. **Push the skill**: run `npx clawhub publish /skills/-cli --slug -cli` 3. After publish, users can install with: ```bash npx clawhub install -cli ``` See [references/openclaw.md](references/openclaw.md) for the full OpenClaw setup workflow. #### To Sundial Hub Publish the generated skill to the Sundial Hub so any agent (Claude Code, Cursor, Codex, etc.) can install it. 1. **Auth**: run `npx sundial-hub auth status`. If not authenticated, ask the user to run `npx sundial-hub auth login` first. **Stop and wait.** 2. **Push the skill**: run `npx sundial-hub push /skills/-cli --visibility public --categories coding` 3. After publish, users can install with: ```bash npx sundial-hub add /-cli ``` #### To api2cli.dev registry Requires the CLI to be on GitHub first. If not on GitHub, run the GitHub publish flow above first. Register on api2cli.dev so others can install with `npx api2cli install `. See [references/publish.md](references/publish.md) for the registry publish workflow. ## Conventions ``` -cli [flags] -cli auth set|show|remove|test ``` `--json` returns: `{ "ok": true, "data": [...], "meta": { "total": 42 } }` Other flags: `--format `, `--verbose`, `--no-color`, `--no-header` Exit codes: 0 = success, 1 = API error, 2 = usage error Tokens: `~/.config/tokens/-cli.txt` (chmod 600)

api2cli

Description

Latest Changes

Install api2cli with One Click