For AI agents#
annals ships artifacts for coding agents alongside its code. This page lists
them, says where each lives in the repository, and points at the
machine-readable copies of this documentation.
Skills#
Skills are folders holding a SKILL.md (the Agent Skills format): a description that tells an agent when to use it and a body with the procedure. Install one into your agent with gh skill (any host: --agent claude-code, copilot, cursor, codex, gemini), or use the copy bundled in the wheel.
annals-publish#
Publish a document or media (a markdown report, an html page, images, video, audio, a PDF, or a whole folder of renders) to the owner’s private annals and hand back the link, so they can read it on a phone or tablet away from the terminal. Use whenever the user asks to “publish this”, “post it to my annals”, “put it where I can read it on my phone”, “give me a link to that report”, “show me the images”, “where can I see the renders”, “share the page with me”, or whenever you have produced a document longer than a few lines that the user will want to read later or elsewhere. Also covers grouping several documents under one link, listing what is in the annals, and moving a document to the recycle bin.
gh skill install thorwhalen/annals annals-publish --agent claude-code
Source: annals/data/skills/annals-publish (bundled with the pip package).
The bundled skills are also on disk after pip install annals, under the package’s data/skills/ directory; link them into an agent without network access with skill link-skills <that directory>.
Machine-readable documentation#
This site publishes the same documentation in forms that fit an agent’s context window:
llms.txt: an index of every page with a one-line description (llms.txt format)annals.md: the whole documentation as one Markdown file<page>.html.md: a rendered Markdown twin of every page, advertised from each page’s<head>with<link rel="alternate" type="text/markdown">objects.inv: the Sphinx inventory: a symbol-to-URL index (sphobjinv convert plain objects.inv -)