Skip to main content

Documentation

Everything you need to turn requirements into reliable software — install in one command, then run the reliability loop: specify, ground, build, remember, verify.

Quick Start

Install the platform, or pick the piece that fits the job. Works on a Claude subscription or an API key. Everything is 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 Platform

attune-ai

The whole platform: spec engine, AI workflows, project memory, retrieval grounding, and verification. 17 multi-stage workflows, 17 skills, 41 MCP tools.

$ pip install attune-ai
Recommended
AI Authoring

attune-author

Generate 15 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

Installing attune-help and attune-author

Both ship as Python packages on PyPI, and their Claude Code plugin versions now live in the same Smart-AI-Memory/attune-ai marketplace as attune-ai itself.

# Install from PyPI
pip install attune-help
pip install 'attune-author[plugin]'

# Or as Claude Code plugins from the attune-ai marketplace
claude plugin marketplace add Smart-AI-Memory/attune-ai
claude plugin install attune-help@attune-ai
claude plugin install attune-author@attune-ai

Attune AI Platform

Beyond AI workflows and verification, the platform keeps your docs grounded too: scan your codebase, generate 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

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 the Claude Code plugin from the attune-ai marketplace
claude plugin install attune-author@attune-ai

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 17 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

The build half of the loop: 17 multi-stage workflows (20 workflows total), 17 auto-triggering Claude Code skills, and an MCP server with 41 registered tools — review, tests, bug prediction, refactor, and release prep.

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

17 Claude Code Skills

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

security-auditsmart-testcode-qualitybug-predictdoc-genrefactor-planrelease-prepplanningspecfix-testworkflow-orchestrationrag-code-genverifyrecallmemory-and-contextcoachattune-hub

Run from CLI

# Run a workflow
attune workflow run security-audit \
--input '{"path":"./src"}'

# Or use Claude Code
/security scan my auth module

Frequently Asked Questions

What is attune-ai?

A spec-driven development platform that turns requirements into reliable software. It combines four pillars — AI workflows, project memory, retrieval grounding, and verification — into one reliability loop: specify with /spec, ground every change in your real code, build with multi-stage workflows, remember what worked across sessions, and verify the output before it ships.

How does it keep generated content from drifting?

Retrieval grounding (powered by attune-rag, a built-in dependency) keeps generated content anchored to your actual source — mean faithfulness is at least 0.97 and CI-gated, so drift fails the build. For docs specifically, templates carry source file hashes; when 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? What do I need to run it?

Fully open source under Apache 2.0 — free for personal, commercial, and enterprise use, with no license keys and no usage limits. It works on a Claude subscription or an API key, so you can run it with whichever access you already have.

What Claude Code skills are included?

17 auto-invoking skills: security audit, smart test, code quality, bug prediction, doc generation, refactor planning, release prep, planning, spec-driven development, fix-test, workflow orchestration, RAG-grounded code generation, content verification, cross-session recall, memory and context, the coach help system, and the attune hub router.

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

Both ship on PyPI: `pip install attune-help` (the reader, no API key required) and `pip install 'attune-author[plugin]'` (the AI authoring companion). Their Claude Code plugin versions now live in the same Smart-AI-Memory/attune-ai marketplace as attune-ai itself: `claude plugin marketplace add Smart-AI-Memory/attune-ai`, then `claude plugin install attune-help@attune-ai` / `attune-author@attune-ai`. (The old Smart-AI-Memory/attune-docs marketplace is retired.)

Ready to Get Started?

Install in one command, then run /spec on your next feature and turn requirements into reliable software.