Google Style Code Docs
jjmartres/opencode
Applies Google Style documentation to Python docstrings, Go comments and Terraform descriptions, for writing new docs or reviewing existing ones.
Kitaru documentation surfaces, link rules, and accuracy rules.
Install Kitaru Docs
$ npx skills add zenml-io/kitaru --skill kitaru-docs -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install zenml-io/kitaru kitaru-docs --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/zenml-io/kitaru.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/kitaru-docs .claude/skills/kitaru-docs && 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 "kitaru-docs" agent skill from https://github.com/zenml-io/kitaru/tree/develop/.agents/skills/kitaru-docs into .claude/skills/kitaru-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "kitaru-docs", 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/zenml-io/kitaru/tree/develop/.agents/skills/kitaru-docsType 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 zenml-io/kitaru --skill kitaru-docs -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install zenml-io/kitaru kitaru-docs --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zenml-io/kitaru.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/kitaru-docs .agents/skills/kitaru-docs && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "kitaru-docs" agent skill from https://github.com/zenml-io/kitaru/tree/develop/.agents/skills/kitaru-docs into .agents/skills/kitaru-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "kitaru-docs", 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 zenml-io/kitaru --skill kitaru-docs -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install zenml-io/kitaru kitaru-docs --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zenml-io/kitaru.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/kitaru-docs .cursor/skills/kitaru-docs && 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 "kitaru-docs" agent skill from https://github.com/zenml-io/kitaru/tree/develop/.agents/skills/kitaru-docs into .cursor/skills/kitaru-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "kitaru-docs", 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/zenml-io/kitaru.git --path .agents/skills/kitaru-docs--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 zenml-io/kitaru --skill kitaru-docs -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install zenml-io/kitaru kitaru-docs --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zenml-io/kitaru.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/kitaru-docs .gemini/skills/kitaru-docs && 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 "kitaru-docs" agent skill from https://github.com/zenml-io/kitaru/tree/develop/.agents/skills/kitaru-docs into .gemini/skills/kitaru-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "kitaru-docs", 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 zenml-io/kitaru kitaru-docsInstalls 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 zenml-io/kitaru --skill kitaru-docs -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/zenml-io/kitaru.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/kitaru-docs .github/skills/kitaru-docs && 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 "kitaru-docs" agent skill from https://github.com/zenml-io/kitaru/tree/develop/.agents/skills/kitaru-docs into .github/skills/kitaru-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "kitaru-docs", 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 zenml-io/kitaru --skill kitaru-docs -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install zenml-io/kitaru kitaru-docs --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zenml-io/kitaru.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/kitaru-docs .opencode/skills/kitaru-docs && 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 "kitaru-docs" agent skill from https://github.com/zenml-io/kitaru/tree/develop/.agents/skills/kitaru-docs into .opencode/skills/kitaru-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "kitaru-docs", 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
kitaru-docs- GitHub stars
- 302
- Token cost
- ~936 tokens
- SKILL.md length
- 442 words
- Files
- 1
- Skills in repo
- 7
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
Kitaru documentation surfaces, link rules, and accuracy rules.
- Works in 3 steps: Hand-written docs are plain Markdown in… → Generated SDK and CLI reference docs… → kitaru.ai/docs/* redirects are handled…
- Editing docs under docs/book
- SKILL.md covers Documentation Surfaces, Docs Content Rules and Example READMEs
- Calls just; reaches sdkdocs.kitaru.ai and docs.zenml.io
What it does
Kitaru Docs is an agent skill from zenml-io/kitaru. Kitaru documentation surfaces, link rules, and accuracy rules. Use when editing docs under docs/book, generated SDK or CLI reference, docs redirects, example READMEs, or docs CI.
Its SKILL.md is about 940 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation. It works with Python. The repository describes itself as: Agent traces you can run, not just read. The licence is Apache-2.0.
When your agent uses it
- Editing docs under docs/book
- Example READMEs
Example prompts
- “/kitaru-docs”
Requirements
- Python 3
Workflow steps
3 steps, taken from the first numbered list in SKILL.md.
- Hand-written docs are plain Markdown in docs/book/, published to docs.zenml.io/kitaru through GitBook Git Sync. Navigation is…
- Generated SDK and CLI reference docs live in the FumaDocs app under docs/, with output under docs/content/docs/reference/ served from…
- kitaru.ai/docs/* redirects are handled by docs/worker/redirect.mjs and wrangler.redirect.toml.
What it can do on your machine
Read from SKILL.md and the folder at commit e7e55f7. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Shell commands in SKILL.md call:
just
From the folder's file list and the shell code blocks in SKILL.md.
Network
Hosts in commands or code, which the agent is likely to contact:
sdkdocs.kitaru.aidocs.zenml.ioassets.kitaru.ai
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
Kitaru Docs loads about 936 tokens when it runs. Until then it costs about 48 tokens; SKILL.md has 442 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); files beside SKILL.md are not scanned.
SKILL.md
The full file from zenml-io/kitaru at commit e7e55f7, republished under its Apache-2.0 licence (© zenml-io). 442 words, ~936 tokens.
Download SKILL.mdSave it as
.claude/skills/kitaru-docs/SKILL.md (or your agent's skills folder).- name
- kitaru-docs
- description
- Kitaru documentation surfaces, link rules, and accuracy rules. Use when editing docs under docs/book, generated SDK or CLI reference, docs redirects, example READMEs, or docs CI.
Kitaru Documentation Workflow
Use this when editing or reviewing Kitaru documentation, examples, generated reference docs, docs redirects, or docs CI behavior.
Documentation Surfaces
Kitaru docs live on three surfaces:
- Hand-written docs are plain Markdown in
docs/book/, published todocs.zenml.io/kitaruthrough GitBook Git Sync. Navigation isdocs/book/toc.md, configuration isdocs/book/.gitbook.yaml, and authoring conventions live indocs/book/AGENTS.md. - Generated SDK and CLI reference docs live in the FumaDocs app under
docs/, with output underdocs/content/docs/reference/served fromsdkdocs.kitaru.ai.scripts/generate_sdk_docs.pyextracts the allowlisted Python API, andscripts/generate_cli_docs.pyreads the offlinekitaru schemacontract. Run both throughjust generate-docs. kitaru.ai/docs/*redirects are handled bydocs/worker/redirect.mjsandwrangler.redirect.toml.
Do not add hand-written pages to docs/content/docs/. The public changelog is owned by the changelog repository at docs.zenml.io/changelog. This repository may generate a gitignored docs/content/docs/changelog.mdx for local reference builds, but agents should not hand-edit or commit it.
The public marketing/runtime site lives in zenml-io-v2. If a task involves Astro pages, public site assets, marketing Cloudflare deployment, or runtime website APIs, switch to that repository instead of adding the code here.
Docs Content Rules
- Only document shipped features; do not add "Coming Soon" sections.
- Inside
docs/book/, link to sibling pages with relative.mdpaths. - Link to SDK reference with
https://sdkdocs.kitaru.ai. - Link to other ZenML docs with absolute
https://docs.zenml.io/...URLs. - Link to diagrams with
https://assets.kitaru.ai/docs/diagrams/<slug>.png. - Do not commit temporary planning/review files or prompt exports unless the user explicitly asks for a durable tracked document.
- Treat
KITARU_*variables as the public configuration surface. - CLI contracts live in
src/kitaru/cli/app.pyand are available offline throughkitaru schema. - The generated OpenAPI document and
src/kitaru/api_models/are the API contract authorities. - Native MCP documentation must match
src/kitaru/mcp/registry.pyandtests/mcp/snapshots/metrics.json. Runjust mcp-schema-check; do not copy tool counts into prose. - The native v2 MCP server does not expose stack or model-alias management.
- Do not document v1 runtime surfaces such as
kitaru init,kitaru stack,kitaru model,kitaru executions,kitaru.llm(), orkitaru.create_stack()unless they are reintroduced in v2 source and tests. - Agent-facing CLI docs should preserve the structured JSON/JSONL,
--machine,--non-interactive, and--no-browsercontracts. - Every
.mdxpage needstitleanddescriptionfrontmatter.
Show full SKILL.md (95 more words)Show less
Do not hand-edit generated reference output. Change the SDK PUBLIC_API allowlist or CLI registration metadata and their tests, then run just generate-docs. The SDK generator needs the fumapy bridge after the docs dependencies are installed.
Example READMEs
Example READMEs are user-facing. They should teach new users what Kitaru does and walk them through the specific example.
Do not add maintainer-oriented sections such as "Testing", CI-only credential setup, or notes about stubbed or mocked runs. If a section would not help a first-time user understand Kitaru, it belongs in tests, contributor docs, or PR descriptions instead.
© zenml-io, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .agents/skills/kitaru-docs of zenml-io/kitaru.
Open the folder on GitHubat commit e7e55f7
Compare with similar skills
Kitaru Docs 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 |
|---|---|---|---|---|---|---|
| Kitaru Docs this skillzenml-io/kitaru | 302 | — | ~936 | Automated safety check: Pass | Apache-2.0 | |
| Google Style Code Docsjjmartres/opencode | 133 | — | ~1.9k | Automated safety check: Pass | MIT | |
| Flowfile Config and Flags CatalogEdwardvaneechoud/Flowfile | 375 | — | ~12k | Automated safety check: Notes | MIT | |
| Project Docsjjmartres/opencode | 133 | — | ~1.3k | Automated safety check: Pass | MIT | |
| Genie API Service Docsqualcomm/qai-appbuilder | 247 | — | ~840 | Automated safety check: Pass | Custom licence | |
| Adk Sample Creatorgoogle/adk-python | 22k | — | ~1.3k | Automated safety check: Pass | Apache-2.0 |
Similar skills
Flowfile Config and Flags Catalog
Edwardvaneechoud/Flowfile
Catalog of Flowfile's environment variables and runtime flags: what each does, where the code reads it, its default, and where the docs disagree with the code.
Project Docs
jjmartres/opencode
Generate comprehensive, professional project documentation structures including README, ARCHITECTURE, USERGUIDE, DEVELOPERGUIDE, and CONTRIBUTING files.
Genie API Service Docs
qualcomm/qai-appbuilder
GenieAPIService technical documentation retrieval. An agent skill from qualcomm/qai-appbuilder.
- Official
Adk Sample Creator
google/adk-python
Creates a new sample agent in the ADK Python repository — the sample directory, its agent.py, and its README.md — following the conventions the existing samples already use.
Crafting Effective Readmes
cumbucadev/cinemaempoa
A skill your agent uses when writing or improving README files.
More from zenml-io/kitaru
Kitaru Release
zenml-io/kitaru
Discover dependencies and prepare or execute Kitaru core and plugin releases, including version proposals, Kitaru UI selection, release PRs, ordered tag commands, artifact verification, and recovery.
Kitaru UI API Development
zenml-io/kitaru
Add, reuse, or change a frontend-specific Kitaru REST response under /api/v1/ui and its OpenAPI contract in zenml-frontend-monorepo.
Kitaru Dev
zenml-io/kitaru
Kitaru just recipes, CLI structure and structured-output contract, analytics events, and PR-description conventions.
Kitaru Adapter Development
zenml-io/kitaru
Add or change a Kitaru framework adapter that records native agent runs or supports bounded replay.
Kitaru Importer Development
zenml-io/kitaru
Add or change a separately packaged Kitaru trace importer that normalizes provider exports into imported sessions.
Kitaru Tests Release
zenml-io/kitaru
Kitaru test layout, CI workflows, and release-workflow behavior.
Related
Works with
Categories
Questions about Kitaru Docs
What does Kitaru Docs do?
Kitaru documentation surfaces, link rules, and accuracy rules. Kitaru Docs is an agent skill from zenml-io/kitaru. Kitaru documentation surfaces, link rules, and accuracy rules.
When should I use Kitaru Docs?
Kitaru Docs fits situations like: editing docs under docs/book; example READMEs.
How do I install Kitaru Docs in Claude Code?
Run `npx skills add zenml-io/kitaru --skill kitaru-docs -a claude-code`. Or copy the skill folder (.agents/skills/kitaru-docs in zenml-io/kitaru) into .claude/skills/kitaru-docs in your project. Claude Code loads it when a task matches its description.
How do I install Kitaru Docs in Codex?
Run `npx skills add zenml-io/kitaru --skill kitaru-docs -a codex`. Or copy the skill folder (.agents/skills/kitaru-docs in zenml-io/kitaru) into .agents/skills/kitaru-docs in your project. Codex loads it when a task matches its description.
Can I use Kitaru Docs 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 zenml-io/kitaru --skill kitaru-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/kitaru-docs, .gemini/skills/kitaru-docs, .github/skills/kitaru-docs and .opencode/skills/kitaru-docs in your project.
What does Kitaru Docs need to run?
Going by SKILL.md and its folder, Kitaru Docs needs the command-line tools its instructions call (just). Our summary lists: Python 3.
Does Kitaru Docs access the network?
SKILL.md names 3 domains. In commands or code: sdkdocs.kitaru.ai, docs.zenml.io and assets.kitaru.ai; the agent is likely to contact these when it follows the instructions. This is read from the text; nothing was executed.
Is Kitaru Docs 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. Review the folder before installing.
What licence does Kitaru Docs use?
Kitaru Docs is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Kitaru Docs use?
About 936 tokens (SKILL.md is roughly 3.7k 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 Kitaru Docs?
Skills that share tags, products or a category with Kitaru Docs: Google Style Code Docs (jjmartres/opencode, 133 stars), Flowfile Config and Flags Catalog (Edwardvaneechoud/Flowfile, 375 stars), Project Docs (jjmartres/opencode, 133 stars) and Genie API Service Docs (qualcomm/qai-appbuilder, 247 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Kitaru Docs?
zenml-io (a GitHub organization) maintains it in zenml-io/kitaru, which has 302 GitHub stars. The repository holds 7 skills in this directory. The repository was last updated on October 8, 2026.
Source: zenml-io/kitaru on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.