What is generate-docs?

A command that creates a flat inventory of a Rust workspace's public code interface, including structs, enums, traits, public functions, and documentation comments.

Use it to document crates in a Cargo workspace, create one Markdown file per crate under docs/symbols, and refresh the workspace's llms.txt files for machine-readable context.

It gives developers and coding agents a quick view of what each crate exposes without requiring them to inspect every implementation detail.

generate-docs — Command by d-oit

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods

npx agentmods add commands/d-oit/rust-2026-template/generate-docs

Clone the repo

git clone --depth 1 https://github.com/d-oit/rust-2026-template

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.

When invoked 244 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. Scan, not verified.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5	$0.00000	$0.00244
Opus 5	$0.00000	$0.00122
Sonnet 5	$0.00000	$0.00049
Haiku 4.5	$0.00000	$0.00024

Measured 2d ago against content hash caf4c3a41057, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

generate-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.opencode/commands/generate-docs.md · 21 lines

What it actually says

Command: generate-docs

Description

Generates a Rust-scoped symbol inventory to assist agents in understanding the public API surface of the workspace.

Execution Protocol

Workspace Discovery: Identify all workspace members defined in Cargo.toml and located in crates/.
Symbol Extraction: For each crate, extract public symbols including:
- struct and enum definitions
- trait definitions
- Public functions (pub fn)
- Associated /// documentation comments
Documentation Generation:
- Primary output: docs/symbols/ directory.
- Create one file per crate: docs/symbols/<crate_name>.md.
Machine Context: Trigger bash scripts/generate-llms-txt.sh to ensure llms.txt and llms-full.txt are up-to-date with any new documentation.

Guidelines

This command is intended to complement cargo doc, providing a more LLM-friendly, flat representation of the codebase.
Focus on the "what" (public interface) rather than the "how" (internal implementation).

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2d ago First seen · 21 lines · 0 tokens per session scan A caf4c3a41057

Subscribe to this mod's changes

generate-docs is a command published in the GitHub repository d-oit/rust-2026-template (10 stars, last pushed 2d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 244 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Backend and APIs Documents Writing and docs ai-agents ai-tooling rust template

OPSX: Verify

Verify implementation matches change artifacts before archiving.

rivet-dev/actors · 13 tokens

OPSX: Continue

Continue working on a change - create the next artifact (Experimental).

rivet-dev/actors · 18 tokens

read

Read a specific section from an arXiv paper's HTML version (ar5iv.org).

actionbook/actionbook · 0 tokens

simplify

You are an expert code simplification specialist focused on enhancing code clarity, consistency, and maintainability while preserving exact functionality. Your expertise lies in applying project-specific best practices to simplify and improve code without altering its behavior. You prioritize readable, explicit code…

macro-inc/macro · 0 tokens

index

Command "index" from thrashr888/agentkernel, covering commands, quick reference, daily drivers (root level), sandbox lifecycle (sandbox / sb) and ssh (ssh).

thrashr888/agentkernel · 0 tokens

tasks

Command "tasks" from thrashr888/agentkernel, covering durable tasks, use up to four task workers (the default) and bound active tasks explicitly.