Daipendency

Daipendency extracts public API documentation from a library and outputs it in an LLM-friendly format. The endgame is to provide AI coding agents with all the context they need to use a particular dependency, but for now you can just use it manually on the CLI.

This project was inspired by Aider's repository map.

Features

• Outputs public symbols (e.g. functions) only.
• Outputs function signatures and documentation, but not the implementation.
• Only supports Rust for now, but any language supported by tree-sitter can be supported.
• Reads the source code directly, so it doesn't process the HTML of the generated documentation, thus keeping the output clean.

CLI Usage

daipendency extract-dep: Extract the documentation of a dependency in a crate

To extract the documentation of a dependency of the crate in the current directory, pass the name of the dependency. For example:

daipendency extract-dep thiserror

Alternatively, you can specify the path to the crate that contains the dependency with the --dependant option. For example:

daipendency extract-dep --dependant=/path/to/your/crate thiserror

This command will honour the version of the dependency specified in the Cargo.toml file.

daipendency extract: Extract the documentation of a crate

To extract the documentation from a library, pass the path to the library. For example:

daipendency extract /path/to/library

Explicitly specifying the language is recommended, as it can be slow to auto-detect. For example:

daipendency extract --language=rust /path/to/library

Library Usage

To use Daipendency in your own Rust project, add it as a dependency and call the generate_documentation function. For example:

use daipendency::{generate_documentation, Language};
use std::path::Path;

let path = Path::new("/path/to/crate");
match generate_documentation(path, Some(Language::Rust)) {
    Ok(output) => println!("{}", output),
    Err(e) => eprintln!("Error: {}", e),
}

You can optionally set language to None to auto-detect the language, but this can get slow as we add more languages.

Development

Adding Support for a New Language

To add support for a new language, you need to:

1. Implement the daipendency_extractor::Extractor trait for the language. See daipendency-extractor-rust for an example.
2. Release your crate. Note that only MIT- or Apache-2.0-licensed crates are eligible for inclusion in Daipendency.
3. Integrate your crate in src/languages.rs.