Skip to content
telos

Rust API Reference

The generated Rust API reference is available at:

Open the telos_agent rustdoc

The website guides explain the main concepts and entry points. Generated rustdoc is the source of truth for item-level details such as module organization, function signatures, trait methods, structs, enums, fields, and feature-specific documentation.

Generate Locally

From the repository root:

Terminal window
./scripts/generate-core-api-docs.sh

The generated entry point is:

target/doc/telos_agent/index.html

Use the library guide for a concise map of the public surface, then use rustdoc when you need exact API signatures.