autoresearch_learn

A code-documentation command that examines a codebase and creates, refreshes, checks, or summarizes documentation. Its wiki mode creates a set of linked pages organized around code modules.

In plain words
What is it for?
Use it to document selected files, focus on specific topics, build a navigable wiki, or produce Markdown, JSON, or reStructuredText output.
Why use it?
It helps keep technical knowledge available when the code is difficult to understand or changes over time. Validation and optional fixes can check whether the documentation is up to date.

Command

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/uditgoenka/autoresearch/autoresearch_learn
Clone the repo
git clone --depth 1 https://github.com/uditgoenka/autoresearch
Per session 27 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 2,094 The whole file, excluding the scripts and references it only reads on demand.
Security scan C 1 finding. Scan, not verified.
Origin 95% copy Near-identical to another mod 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.

ModelPer sessionOnce invoked
Fable 5 $0.00027 $0.02094
Opus 5 $0.00014 $0.01047
Sonnet 5 $0.00005 $0.00419
Haiku 4.5 $0.00003 $0.00209

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

Security

Grade C, and why

autoresearch_learn scanned grade C with 1 finding 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 yesterday.

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.

Harvests environment variableshighData exfiltration

Enumerating or grepping the environment for keys collects credentials unrelated to what the mod says it does.

- **Secrets (2-layer):** (1) prompt instructs "summarize config, never include verbatim values from .env/credentials or strings matching key/secret/token/password; extract env var *names* not *values*"; (2) post-gen, `gr
Origin

This is a copy

95% identical to autoresearch:learn — 4 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.opencode/commands/autoresearch_learn.md · 137 lines

How it starts

The opening of the file, as written. The whole thing — 137 lines — stays where its author put it; the contents beside it link to each section on GitHub.

EXECUTE IMMEDIATELY.

Parse Arguments

Extract from $ARGUMENTS:

  • Mode: or --mode — init (create from scratch), update (refresh existing), check (validate), summarize (brief overview), wiki (navigable knowledge base)
  • Scope: or --scope — file globs to document
  • Depth: or --depth — overview, standard, comprehensive
  • --file <path> — specific file to document
  • --scan — force fresh codebase scout
  • --topics — comma-separated focus topics
  • --modules <list> — wiki mode: comma-separated module names/paths overriding auto-detection
  • --force — wiki mode: regenerate all pages from scratch, ignore existing manifest
  • --no-fix — validate only, don't auto-fix issues
  • --format — markdown (default), json, rst
  • Iterations: or --iterations — default 10. "unlimited" for unbounded.
  • --evals, --evals-interval N, --chain, --<subcommand>

Setup (if Mode or Scope missing)

question (single batch): Q1 (Mode): "What to do?" — init (generate docs), update (refresh), check (validate), summarize (overview), wiki (knowledge base) Q2 (Scope): "Which files?" — suggested globs + entire codebase Q3 (Depth): "How detailed?" — overview only, standard, comprehensive Q4 (Topics): "Focus on?" — architecture, API, database, testing, all If all provided → skip.

Establish Baseline

  1. Scout codebase: file tree, imports/exports, existing docs
  2. Identify documentation gaps (undocumented files, outdated docs, missing READMEs)
  3. Create output directory: autoresearch/learn-{YYMMDD}-{HHMM}/
  4. TSV header: # metric_direction: higher_is_better\niteration\ttimestamp\tfile_documented\tvalidation_status\tissues_found\tissues_fixed\tdescription
  5. Metric = files with valid documentation (higher is better)

Summarize Mode (no loop)

If mode == summarize:

  • One-shot: scan codebase → produce structured summary
  • Write summary.md to output directory
  • Skip iteration loop entirely

Wiki Mode (no per-file loop)

If mode == wiki: reuse Scout (Phase 1) + Analyze output, then generate a navigable wiki/ knowledge base. Skip the init/update/check loop. Metric = pages_generated / pages_planned × 100 (from manifest); size target 300 lines/page.

Read the full file on GitHub · 137 lines

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.

  1. yesterday First seen · 137 lines · 27 tokens per session scan C fdc7f08a3584

Subscribe to this mod's changes

autoresearch_learn is a command published in the GitHub repository uditgoenka/autoresearch (5,966 stars, last pushed 19d ago), licensed MIT. It adds 27 tokens to every session and 2,094 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it C with 1 finding (harvests environment variables). It is 95% identical to autoresearch:learn, differing in 4 lines, and is treated as a copy.