Documentation

Everything you need to generate, serve, and maintain help content from your codebase.

Quick Start

Choose the package that fits your needs. All four are open source under Apache 2.0.

Recommended

Reader Only

attune-help

Lightweight reader for .help/ templates. 1 dependency, 6 files. Embed in any Python tool. No AI key required.

$ pip install attune-help

Full Framework

attune-ai

Generate, maintain, and serve help from your codebase. 15 workflows, 14 skills, MCP server.

$ pip install attune-ai

Recommended

AI Authoring

attune-author

Generate 11 kinds of source-grounded templates with per-type polish prompts. Pairs with attune-help.

$ pip install 'attune-author[plugin]'

Claude Code

Plugin

Install from the marketplace. Type /coach for progressive help right in your terminal.

$ claude plugin marketplace add Smart-AI-Memory/attune-ai

attune-help and attune-author plugins live in the attune-docs marketplace

After the 2026-04-10 split, the Claude Code plugin versions of attune-help and attune-author live in a separate marketplace from the main attune-ai plugin. Add that marketplace first, then install whichever plugin(s) you want.

# Add the attune-docs marketplace

claude plugin marketplace add Smart-AI-Memory/attune-docs

# Install the reader (no API key required)

claude plugin install attune-help@attune-docs

# Install the AI authoring companion

claude plugin install attune-author@attune-docs

Attune AI Framework

The full pipeline: scan your codebase, generate help templates, detect when code drifts, and regenerate stale content.

1. Bootstrap

Scan your project to discover features. The scanner reads modules, classes, and functions, then proposes a features.yaml manifest.

/coach init

2. Generate

For each feature, three templates are created: concept (what is it?), task (how to use it), and reference (full API detail). Content comes from actual source code.

/coach maintain

3. Staleness Detection

Source file SHA-256 hashes are stored in template frontmatter. When code changes, stale templates are flagged automatically.

/coach status

4. Maintenance

Regenerate only the templates whose source changed. Hand-written templates are preserved. Run on-demand or via CI.

/coach maintain

Deep API reference in framework docs

Attune Help (Standalone Reader)

A lightweight Python package that reads .help/ templates. 1 dependency, 6 files, embeddable anywhere.

Features

11 dependency — python-frontmatter. No bloat.
2Progressive depth — concept on first ask, task on repeat, reference on third.
3Session storage — file-based or custom backend. Tracks depth per topic.
4Multiple renderers — plain text, CLI, Claude Code, marketplace.

Usage

# Install

pip install attune-help

# Use

from

attune_help

import

HelpEngine

engine = HelpEngine(
template_dir=".help/templates"
)
result = engine.lookup("security-audit")

Attune Author

The AI authoring companion for attune-help. Generates source-grounded templates from your codebase and polishes them with per-type LLM prompts.

11 Template Kinds

Up from 3 in v0.1.0. The generator produces the full set of shapes attune-help renders:

concept

task

reference

error

warning

troubleshooting

faq

quickstart

tip

note

comparison

Default calls produce the original three kinds unchanged. The eight new kinds are strictly opt-in via the depths= kwarg.

Per-Type Polish

Each template kind gets its own system prompt that teaches the LLM what “good” looks like for that shape:

Concept — definitional clarity and mental models
Task — “Use X when…” openers and verifiable success criteria
Troubleshooting — symptom tables and step-by-step diagnosis
Comparison — decision tables with “Use X when…” recommendations

Plus signature-aware source summaries that feed the LLM typed function and method signatures, so the polished output stays factually grounded in your actual code.

Install and Generate

# PyPI install (includes the polish runtime)

pip install 'attune-author[plugin]'

# Or via the attune-docs marketplace for Claude Code

claude plugin install attune-author@attune-docs

Requires ANTHROPIC_API_KEY for the polish pass. Without it, the generator falls back to the raw Jinja2 drafts. SetATTUNE_AUTHOR_STRICT_POLISH=1 to make polish failures hard errors for CI.

Claude Code Plugin

Install from the marketplace. Progressive help, project bootstrapping, and 14 skills right in your terminal.

Install

$ claude plugin marketplace add Smart-AI-Memory/attune-ai

$ claude plugin install attune-ai@attune-ai

/coach Commands

/coach <topic>

Progressive lookup. First call returns concept, repeat returns task, third returns reference.

/coach init

Bootstrap a .help/ directory for your project. Scans source code and generates features.yaml.

/coach status

Check template freshness. Shows which features have drifted from their source files.

/coach maintain

Regenerate stale templates. Only updates files whose source hashes changed.

Workflows & Skills

attune-ai includes 15 multi-stage workflows, 14 auto-invoking Claude Code skills, and an MCP server with 41 registered tools.

Key Workflows

Security Audit

OWASP-focused vulnerability scan

Code Review

Multi-tier analysis with architecture feedback

Bug Prediction

Pattern-based risk scoring

Test Generation

Parametrized pytest generation

Deep Review

Multi-pass security, quality, and test gap analysis

Documentation

Docstring and API reference generation

Performance Audit

Profiling and optimization suggestions

Refactoring

Code smell detection and roadmap

Release Prep

Changelog, version bump, health checks

14 Claude Code Skills

Skills auto-invoke from natural language. Type the topic and the right skill fires.

/security/smart-test/code-quality/deep-review/doc-gen/refactor/release/plan/brainstorm/spec/fix-test/bulk/coach/attune

Run from CLI

# Run a workflow

attune workflow run security-audit \

--input '{"path":"./src"}'

# Or use Claude Code

/security scan my auth module

Full workflow documentation

Frequently Asked Questions

How is this different from a wiki?

Wiki pages drift the moment code changes. Attune templates are generated from your source code and include file hashes. When the code changes, staleness detection flags the affected templates so they can be regenerated automatically.

Do I need attune-ai to read templates?

No. The standalone attune-help package (1 dependency) can read any .help/ directory without the full framework. Generate templates with attune-author or attune-ai, then ship them alongside attune-help for a minimal runtime with no Anthropic API key required.

Can I write templates by hand?

Yes. Hand-written templates are preserved during regeneration. Remove the auto-discovered tag from frontmatter and the maintenance system will skip the file.

How does staleness detection work?

Each template stores SHA-256 hashes of the source files it was generated from. The maintenance workflow re-hashes those files and compares. If the hash changed, the template is flagged stale and queued for regeneration.

Is it free?

Fully open source under Apache 2.0. Free for personal, commercial, and enterprise use. No license keys, no usage limits.

What Claude Code skills are included?

14 auto-invoking skills: security audit, smart test, code review, deep review, doc generation, refactoring, bug prediction, release prep, planning, brainstorming, workflow orchestration, fix-test, spec-driven development, and the coach help system.

Where do I install attune-help and attune-author from?

They live in the Smart-AI-Memory/attune-docs marketplace, not the main attune-ai marketplace. Add the marketplace with `claude plugin marketplace add Smart-AI-Memory/attune-docs`, then install the plugin(s) you want: `attune-help@attune-docs` for the reader and/or `attune-author@attune-docs` for the AI authoring companion. For PyPI direct installs, `pip install attune-help` and `pip install 'attune-author[plugin]'` also work.

Ready to Get Started?

Generate help content from your codebase in under 5 minutes.

View on GitHub Install Now