API Reference

Overview

The project is a codebase documentation generation tool that uses large language models (LLMs) to automatically produce documentation from source code analysis. It is organized into several cooperating subsystems: a networking and protocol layer (built from protocol, client, http, network, openai, anthropic, and provider) that abstracts provider-specific API interactions; an extraction pipeline (extract and schema) that parses code into structured representations; an agent module that drives an LLM-based exploration loop using tool calls; and a generate module that renders the final documentation output. Configuration is managed by the config module, while support provides shared utilities for file I/O, hashing, and logging.

Readers should view the project as a pipeline where source code is first analyzed and represented in a schema, an LLM agent then iteratively inspects the codebase, and the results are assembled into documentation pages. The networking modules handle the asynchronous communication with various LLM backends, while the agent orchestrates the conversation and caching. This modular design allows each subsystem to be developed and tested independently while contributing to the overall goal of automated documentation generation.

Modules

• agent
• agent:tools
• anthropic
• client
• config
• config:load
• config:normalize
• config:schema
• config:validate
• extract
• extract:ast
• extract:cache
• extract:compiler
• extract:filter
• extract:merge
• extract:model
• extract:scan
• generate
• generate:analysis
• generate:cache
• generate:common
• generate:diagram
• generate:dryrun
• generate:evidence
• generate:markdown
• generate:model
• generate:page
• generate:planner
• generate:scheduler
• generate:symbol
• http
• network
• openai
• protocol
• provider
• schema
• support

Namespaces

• clore
• clore::agent
• clore::config
• clore::extract
• clore::extract::cache
• clore::generate
• clore::generate::cache
• clore::logging
• clore::net
• clore::net::anthropic
• clore::net::anthropic::detail
• clore::net::anthropic::protocol
• clore::net::anthropic::protocol::detail
• clore::net::anthropic::schema
• clore::net::detail
• clore::net::openai
• clore::net::openai::detail
• clore::net::openai::protocol
• clore::net::openai::protocol::detail
• clore::net::openai::schema
• clore::net::openai::schema::detail
• clore::net::protocol
• clore::net::schema
• clore::support

Module Dependency Diagram