cli.agent_docs

cli.agent_docs

Bundled agent documentation for axolotl.

These docs are optimized for consumption by AI coding agents. The source of truth is docs/agents/*.md and AGENTS.md in the repo root. This module resolves those paths at runtime — no files are duplicated into the package.

For pip-only installs (no repo checkout), run axolotl fetch docs first to download the docs locally.

Functions

Name	Description
get_doc	Return the content of an agent doc by topic name.
list_topics	Return a dict of topic name -> first line (title) of each doc.

get_doc

cli.agent_docs.get_doc(topic='overview')

Return the content of an agent doc by topic name.

Parameters

Name	Type	Description	Default
topic	str	One of the keys in TOPICS, or “overview” (default).	'overview'

Returns

Name	Type	Description
	str	The markdown content of the doc.

Raises

Name	Type	Description
	FileNotFoundError	If the topic can’t be found.

list_topics

cli.agent_docs.list_topics()

Return a dict of topic name -> first line (title) of each doc.