<!-- generated by epythet -->

# For AI agents

`contaix` 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](https://agentskills.io) 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.

### `contaix-acquire-docs`

Acquire a tool’s documentation as a single agent-ready markdown bundle, plus any machine-readable specs (OpenAPI, MCP, AsyncAPI, GraphQL). Use whenever the user provides one or more URLs (or a tool/product name) and wants the docs / manual / API reference as a context bundle for an AI agent. Triggers on “acquire the docs”, “get me the docs”, “bundle this manual”, “make a context for tool X”, “download the API reference”, “give me everything as one md”, “fetch the OpenAPI spec”, “grab the MCP spec”, or any URL pointing at a documentation / developer / API / manual site. Tries cheapest paths first — GitHub source, llms.txt, raw-markdown variants of doc URLs — and only falls back to HTML scraping (via contaix_docs_to_markdown / contaix_web_aggregate) when nothing better is available.

```bash
gh skill install thorwhalen/contaix contaix-acquire-docs --agent claude-code
```

Source: [`skills/contaix-acquire-docs`](https://github.com/thorwhalen/contaix/tree/HEAD/skills/contaix-acquire-docs).

### `contaix_docs_to_markdown`

Convert a documentation website into a single, clean markdown file. Use when the user provides a documentation URL and wants it as markdown, or says “get me the docs”, “download documentation”, “make a markdown of this site”, “aggregate these docs”, or gives a URL to a docs site. Also use for converting API reference sites, developer guides, product documentation, or knowledge bases.

```bash
gh skill install thorwhalen/contaix contaix_docs_to_markdown --agent claude-code
```

Source: [`skills/contaix_docs_to_markdown`](https://github.com/thorwhalen/contaix/tree/HEAD/skills/contaix_docs_to_markdown).

### `contaix_web_aggregate`

Aggregate web content from multiple pages into structured markdown. Use when the user wants to aggregate a non-documentation website (company info, product pages), when contaix_docs_to_markdown doesn’t work for a specific site, when the user wants manual control over which pages to include, or when dealing with JavaScript-rendered sites that need WebFetch.

```bash
gh skill install thorwhalen/contaix contaix_web_aggregate --agent claude-code
```

Source: [`skills/contaix_web_aggregate`](https://github.com/thorwhalen/contaix/tree/HEAD/skills/contaix_web_aggregate).

## Instruction files

Files agents read before working in this repository.

- [`.claude/CLAUDE.md`](https://github.com/thorwhalen/contaix/tree/HEAD/.claude/CLAUDE.md): read by Claude Code

## Machine-readable documentation

This site publishes the same documentation in forms that fit an agent’s context window:

- [`llms.txt`](https://thorwhalen.github.io/contaix/llms.txt): an index of every page with a one-line description ([llms.txt](https://llmstxt.org) format)
- [`contaix.md`](https://thorwhalen.github.io/contaix/contaix.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`](https://thorwhalen.github.io/contaix/objects.inv): the Sphinx inventory: a symbol-to-URL index (`sphobjinv convert plain objects.inv -`)
