CLI Creator
huangruiteng/CS-Notes
Build a composable CLI for Codex from API docs, an OpenAPI spec, existing curl examples, an SDK, a web app, an admin tool, or a local script.
Generate API documentation from code. An agent skill from huangjia2019/claude-code-engineering.
Install API Documenting
$ npx skills add huangjia2019/claude-code-engineering --skill api-documenting -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install huangjia2019/claude-code-engineering api-documenting --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .claude/skills && cp -r skills-src/04-Skills/projects/02-progressive-skill .claude/skills/api-documenting && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "api-documenting" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/02-progressive-skill into .claude/skills/api-documenting/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenting", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/02-progressive-skillType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add huangjia2019/claude-code-engineering --skill api-documenting -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install huangjia2019/claude-code-engineering api-documenting --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .agents/skills && cp -r skills-src/04-Skills/projects/02-progressive-skill .agents/skills/api-documenting && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "api-documenting" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/02-progressive-skill into .agents/skills/api-documenting/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenting", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add huangjia2019/claude-code-engineering --skill api-documenting -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install huangjia2019/claude-code-engineering api-documenting --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/04-Skills/projects/02-progressive-skill .cursor/skills/api-documenting && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "api-documenting" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/02-progressive-skill into .cursor/skills/api-documenting/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenting", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/huangjia2019/claude-code-engineering.git --path 04-Skills/projects/02-progressive-skill--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add huangjia2019/claude-code-engineering --skill api-documenting -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install huangjia2019/claude-code-engineering api-documenting --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/04-Skills/projects/02-progressive-skill .gemini/skills/api-documenting && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "api-documenting" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/02-progressive-skill into .gemini/skills/api-documenting/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenting", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install huangjia2019/claude-code-engineering api-documentingInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add huangjia2019/claude-code-engineering --skill api-documenting -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .github/skills && cp -r skills-src/04-Skills/projects/02-progressive-skill .github/skills/api-documenting && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "api-documenting" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/02-progressive-skill into .github/skills/api-documenting/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenting", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add huangjia2019/claude-code-engineering --skill api-documenting -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install huangjia2019/claude-code-engineering api-documenting --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/04-Skills/projects/02-progressive-skill .opencode/skills/api-documenting && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "api-documenting" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/02-progressive-skill into .opencode/skills/api-documenting/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenting", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
api-documenting- GitHub stars
- 1.1k
- Used in
- 1 other repo
- Token cost
- ~396 tokens
- SKILL.md length
- 138 words
- Files
- 11 (incl. scripts)
- Skills in repo
- 10
- Repo updated
- First seen
- Licence
- None found
At a glance
Generate API documentation from code. An agent skill from huangjia2019/claude-code-engineering.
- Works in 4 steps: Identify API Endpoints → Extract Information → Generate Documentation → …
- The user wants to document APIs
- SKILL.md covers Quick Reference, Documentation Standards, Process and Output Formats, plus 2 more sections
- Runs Python and Shell scripts from its folder; calls python
What it does
API Documenting is an agent skill from huangjia2019/claude-code-engineering. Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.
Its SKILL.md is about 400 tokens, which your agent loads only when the skill is triggered. The skill folder holds 13 other files, including scripts (for example `EXAMPLES.md`, `PATTERNS.md` and `README.md`).
It sits in Backend & APIs, covering OpenAPI specifications and Technical documentation. It works with OpenAPI. The repository describes itself as: This repository demonstrates how to use Claude Code to do real engineering work, not just writing code. 本项目是极客时间专栏 《Claude Code 工程化实战》 的官方配套示例仓库，目标就是： 👉 把 Claude Code…
When your agent uses it
- The user wants to document APIs
- Create API reference
- Generate endpoint documentation
- Needs help with OpenAPI/Swagger specs
Example prompts
- “/api-documenting”
Requirements
- Python 3
- A Bash shell
- Pre-approved tools (allowed-tools): Read, Grep, Glob, Write
Workflow steps
4 steps, taken from the step headings in SKILL.md.
- Identify API Endpoints
- Extract Information
- Generate Documentation
- Create Overview
What it can do on your machine
Read from SKILL.md and the folder at commit 89fea03. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves these tools, so the agent can use them without asking each time:
ReadGrepGlobWrite
From allowed-tools in the SKILL.md frontmatter.
Runs code
Ships 2 files in scripts/ (Python and Shell), which the agent can run.
Shell commands in SKILL.md call:
python
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
API Documenting loads about 396 tokens when it runs. Until then it costs about 48 tokens; SKILL.md has 138 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.
SKILL.md
Without a licence we can't republish the file, so here is its outline and opening line. It has 138 words (~396 tokens).
“Generate comprehensive API documentation from source code.”
- name
- api-documenting
- allowed-tools
- Read, Grep, Glob, Write
Files
SKILL.md and 10 other files (scripts) in 04-Skills/projects/02-progressive-skill of huangjia2019/claude-code-engineering.
- SKILL.md
- .claude/skills
- EXAMPLES.md
- PATTERNS.md
- README.md
- STANDARDS.md
- scripts/detect_routes.py
- scripts/validate_openapi.sh
- templates/endpoint.md
- templates/index.md
- templates/openapi.yaml
Open the folder on GitHubat commit 89fea03
Used in 1 other repository
We found 3 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in huangjia2019/claude-code-engineering, which our catalogue first saw on October 7, 2026.
Compare with similar skills
API Documenting next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| API Documenting this skillhuangjia2019/claude-code-engineering | 1.1k | 1 repos | ~396 | Automated safety check: Pass | None | |
| CLI Creatorhuangruiteng/CS-Notes | 4k | 2 repos | ~2.7k | Automated safety check: Pass | Apache-2.0 | |
| Api2clialexknowshtml/api2cli | 455 | — | ~2.9k | Automated safety check: Pass | MIT | |
| Distilled SDKalchemy-run/distilled | 431 | — | ~6k | Automated safety check: Pass | Apache-2.0 | |
| API Documenteralirezarezvani/claude-code-tresor | 777 | — | ~1.5k | Automated safety check: Pass | MIT | |
| OpenAPI Spec Generationwshobson/agents | 40k | 10 repos | ~511 | Automated safety check: Pass | MIT |
Similar skills
Api2cli
alexknowshtml/api2cli
Generate a working CLI from any API, then wrap it in a Claude Code skill.
Distilled SDK
alchemy-run/distilled
Build or update a distilled SDK for an API provider — sourcing its OpenAPI/Smithy/GraphQL/discovery description, adding the spec mirror that feeds it, generating packages/<provider, listing it on…
API Documenter
alirezarezvani/claude-code-tresor
Auto-generate API documentation from code and comments. An agent skill from alirezarezvani/claude-code-tresor.
OpenAPI Spec Generation
wshobson/agents
Create, validate and maintain OpenAPI 3.1 specs for REST APIs, whether designed first or generated from existing code, and use them for docs and client SDKs.
Sap API Style
secondsky/sap-skills
This skill provides comprehensive guidance for documenting SAP APIs following the SAP API Style Guide standards.
More from huangjia2019/claude-code-engineering
All 10 skills in this repoFinancial Analyzing
huangjia2019/claude-code-engineering
Analyze financial data, calculate financial ratios, and generate analysis reports.
API Generating
huangjia2019/claude-code-engineering
Generate API endpoint code and documentation from specifications.
API Generating
huangjia2019/claude-code-engineering
Generate API endpoint documentation from Express route files.
Code Health Check
huangjia2019/claude-code-engineering
Perform a comprehensive code health check on a directory. An agent skill from huangjia2019/claude-code-engineering.
API Conventions
huangjia2019/claude-code-engineering
API design patterns and conventions for this project. An agent skill from huangjia2019/claude-code-engineering.
Code Reviewing
huangjia2019/claude-code-engineering
Review code for quality, security, and best practices. An agent skill from huangjia2019/claude-code-engineering.
Related
Works with
Categories
Questions about API Documenting
What does API Documenting do?
Generate API documentation from code. An agent skill from huangjia2019/claude-code-engineering. API Documenting is an agent skill from huangjia2019/claude-code-engineering. Generate API documentation from code.
When should I use API Documenting?
API Documenting fits situations like: the user wants to document APIs; create API reference; generate endpoint documentation; needs help with OpenAPI/Swagger specs.
How do I install API Documenting in Claude Code?
Run `npx skills add huangjia2019/claude-code-engineering --skill api-documenting -a claude-code`. Or copy the skill folder (04-Skills/projects/02-progressive-skill in huangjia2019/claude-code-engineering) into .claude/skills/api-documenting in your project. Claude Code loads it when a task matches its description.
How do I install API Documenting in Codex?
Run `npx skills add huangjia2019/claude-code-engineering --skill api-documenting -a codex`. Or copy the skill folder (04-Skills/projects/02-progressive-skill in huangjia2019/claude-code-engineering) into .agents/skills/api-documenting in your project. Codex loads it when a task matches its description.
Can I use API Documenting in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add huangjia2019/claude-code-engineering --skill api-documenting -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-documenting, .gemini/skills/api-documenting, .github/skills/api-documenting and .opencode/skills/api-documenting in your project.
What does API Documenting need to run?
Going by SKILL.md and its folder, API Documenting needs Python and a shell for the scripts in its folder and the command-line tools its instructions call (python). Our summary lists: Python 3; A Bash shell. Its frontmatter pre-approves these tools: Read, Grep, Glob, Write.
Does API Documenting access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is API Documenting safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.
What licence does API Documenting use?
No licence was found for API Documenting or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.
How many tokens does API Documenting use?
About 396 tokens (SKILL.md is roughly 1.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to API Documenting?
Skills that share tags, products or a category with API Documenting: CLI Creator (huangruiteng/CS-Notes, 4k stars), Api2cli (alexknowshtml/api2cli, 455 stars), Distilled SDK (alchemy-run/distilled, 431 stars) and API Documenter (alirezarezvani/claude-code-tresor, 777 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains API Documenting?
huangjia2019 (a GitHub user) maintains it in huangjia2019/claude-code-engineering, which has 1,133 GitHub stars. The repository holds 10 skills in this directory. The repository was last updated on July 23, 2026.
Source: huangjia2019/claude-code-engineering on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.