An Agent Skill that gives your AI agent offline access to Zeal documentation on Linux. Instead of guessing at APIs from training data, the agent reads the exact docset installed on your machine — signatures, flags, examples, and narrative guides alike.
| Requirement | Notes |
|---|---|
| Zeal (Linux) | At least one docset downloaded |
| Python 3.8+ | python3 on $PATH |
| beautifulsoup4 | pip install beautifulsoup4 |
| PyYAML | pip install pyyaml (needed by sync_description.py only) |
| An agentskills-compatible agent (Linux) | See the Client Showcase for compatible agents |
Clone the repo into whichever directory your agent loads skills from:
git clone https://github.com/xr09/zeal-docs /path/to/your/skills/zeal-docsRefer to your agent's documentation for the correct skills directory. For example, pi uses ~/.pi/agent/skills/, Claude Code uses ~/.claude/skills/.
Important: the directory must be named
zeal-docs(matching the skill'snamefield). A plaingit cloneof this repo gets that right automatically.
pip install beautifulsoup4 pyyamllxml is optional but gives faster HTML parsing:
pip install lxmlThe skill's description field lists the docsets the agent should look for.
By default it mentions the docsets I use, you should update it to yours.
Run this once after cloning (and again whenever you install or remove docsets
in Zeal):
python3 /path/to/zeal-docs/scripts/sync_description.pyUse --dry-run to preview changes without writing anything:
python3 /path/to/zeal-docs/scripts/sync_description.py --dry-runThe agent picks up new skills on startup. Restart it so it discovers
zeal-docs.
The agent activates this skill automatically whenever a task involves a technology covered by an installed docset. No manual invocation is needed.
To use the helper script directly (e.g. for debugging or exploration):
ZD="python3 /path/to/zeal-docs/scripts/zeal_docs.py"
$ZD list
$ZD search "json.loads" -d py
$ZD show "Python_3::doc/library/json.html#json.loads"See SKILL.md for full query syntax and examples.
Run scripts/sync_description.py after installing or removing docsets in Zeal
to keep the SKILL.md description current:
python3 /path/to/zeal-docs/scripts/sync_description.pyPass --help for all options.
MIT