attune-help

Lightweight help runtime with progressive depth and audience adaptation. Read project help templates generated by attune-ai.

Install

pip install attune-help

Quick Start

from attune_help import HelpEngine

engine = HelpEngine(template_dir=".help/templates")

# Progressive depth: concept -> task -> reference
print(engine.lookup("security-audit"))   # concept
print(engine.lookup("security-audit"))   # task
print(engine.lookup("security-audit"))   # reference

How It Works

Each topic has three depth levels:

Repeated lookups on the same topic auto-advance. A new topic resets to concept.

Renderers

# Plain text (default)
engine = HelpEngine(renderer="plain")

# Rich terminal output (requires `pip install attune-help[rich]`)
engine = HelpEngine(renderer="cli")

# Claude Code inline format
engine = HelpEngine(renderer="claude_code")

# Structured JSON (for apps, web, tests)
engine = HelpEngine(renderer="json")

# Auto-detect environment (CLAUDE_CODE → claude_code,
# interactive TTY + rich → cli, otherwise → plain)
engine = HelpEngine(renderer="auto")

# Switch renderer at runtime
engine.set_renderer("cli")

Passing an unknown renderer name raises ValueError.

Template Directory

Templates are markdown files with YAML frontmatter:

.help/templates/
  security/
    concept.md
    task.md
    reference.md
  api/
    concept.md
    task.md
    reference.md

Generate templates with attune-ai:

pip install attune-ai
# Then in Claude Code:
/coach init

Or create them manually — any markdown file with feature, depth, and source_hash frontmatter fields works.

Demo Templates

The package includes a demo feature showing the progressive depth format:

from attune_help import get_demo_path

# Copy to your project
import shutil
shutil.copytree(
    get_demo_path() / "security-audit",
    ".help/templates/security-audit",
)

The security-audit/ demo contains concept.md, task.md, and reference.md — the three depth levels that /coach init generates for each feature.

Discovery

engine.list_topics()                  # all slugs
engine.list_topics(type_filter="concepts")  # filter by type
engine.search("security")             # [(slug, score), ...]
engine.suggest("secrity-audit")       # ranked slugs

Miss handling:

# Returns None by default
engine.lookup("typoed-slug")

# Returns "No help for 'typoed-slug'. Did you mean: ..."
engine.lookup("typoed-slug", suggest_on_miss=True)

Progressive Depth Controls

engine.lookup("security-audit")    # concept
engine.lookup("security-audit")    # task
engine.lookup("security-audit")    # reference (depth 2)

engine.simpler("security-audit")   # step back to task
engine.simpler("security-audit")   # step back to concept

engine.reset("security-audit")     # clear one topic
engine.reset()                     # clear all topics

Topics are tracked independently — interleaving lookup("a") / lookup("b") / lookup("a") does not reset a's depth. An LRU cap of 32 topics keeps session state bounded.

MCP Server

Install with the plugin extra and use as an MCP server:

pip install attune-help[plugin]
attune-help-mcp   # stdio transport

Exposed tools (all prefixed lookup_ for namespace hygiene against other plugins):

All tools that render help content accept the same renderer set as the Python API: plain, claude_code, cli, marketplace, json (the auto sentinel is excluded because auto-detection is meaningless over a protocol boundary).

API

HelpEngine

HelpEngine(
    template_dir=None,    # Override template path
    storage=None,         # Session storage backend
    renderer="plain",     # Output renderer
    user_id="default",    # Session tracking ID
)

Methods:

• lookup(topic, *, suggest_on_miss=False) — Progressive depth lookup with optional "did you mean" on miss
• simpler(topic) — Step back one depth level
• reset(topic=None) — Clear depth history for one topic or all
• list_topics(type=None, limit=None) — Enumerate slugs
• search(query, limit=10) — Fuzzy-search slugs
• suggest(topic, limit=5) — Ranked slug suggestions
• get(template_id) — Direct template access
• lookup_raw(topic) — Returns PopulatedTemplate dataclass
• get_summary(skill) — One-line skill summary (falls back to bundled when an override lacks it)
• precursor_warnings(file_path) — File-aware warnings (supports Python, JS/TS, Rust, Go, Ruby, Java, …)
• set_renderer(name) — Change renderer at runtime

SessionStorage Protocol

Session depth state defaults to LocalFileStorage (per-user JSON files under ~/.attune-help/sessions/, 4-hour TTL). Implement the protocol to plug in any backend:

from attune_help import SessionStorage

class MyStorage(SessionStorage):
    def get_session(self, user_id: str) -> dict: ...
    def set_session(self, user_id: str, state: dict) -> None: ...

BackendSessionStorage — bring your own key/value store

For cross-host continuity without writing the protocol yourself, inject any key/value backend (an attune_redis backend, attune's MemoryBackend, or a custom object exposing stash/retrieve). attune-help imports none of these, so this adds no required dependency (ADR-002 stays intact):

from attune_help import BackendSessionStorage, HelpEngine

class KVBackend:                      # your store — e.g. wrap Redis
    def stash(self, key: str, value: str) -> bool: ...
    def retrieve(self, key: str) -> str | None: ...

storage = BackendSessionStorage(my_backend)   # same schema + 4h TTL
engine = HelpEngine(storage=storage)

Schema, TTL, and legacy migration match LocalFileStorage exactly — only the transport (a backend key instead of a file) differs. Backend errors never propagate into the runtime: reads fall back to defaults, writes log-and-continue.

Staleness Detection (moved to attune-author)

Staleness tracking — manifest loading, SHA-256 + semantic hashing, and freshness symbol extraction — moved to attune-author in 0.11.0. The deprecated attune_help.manifest / staleness / freshness re-export shims were removed in 0.12.0; import from attune_author.* directly:

from attune_author.manifest import load_manifest
from attune_author.staleness import check_staleness

manifest = load_manifest(".help")
report = check_staleness(manifest, help_dir=".help", project_root=".")

for entry in report.stale_features:
    print(f"{entry} is stale — regenerate with attune-ai")

Semantic hashing (contract-only hashes for pure-Python features) is documented in the attune-author README.

Corpus validation

A 3-sweep validation harness ships in scripts/validate_against_corpus.py (a maintainer tool — requires attune-author installed):

# Validate against any repo with a .help/features.yaml
python scripts/validate_against_corpus.py --repo /path/to/your/repo

Sweeps: (1) parse integrity — all .py files parse cleanly; (2) determinism — identical hashes on two consecutive calls; (3) HEAD vs HEAD^ — classifies symbol changes as signature drift / body-only / add / remove.

Template aliases

Templates can declare aliases: in their frontmatter to cover retrieval gaps — synonyms and alternate phrasings that keyword search would otherwise miss:

---
type: concept
feature: tool-planning
aliases:
  - how to plan tools
  - tool design principles
  - when to use tools
---

aliases is a YAML list of strings. The retrieval engine scores alias hits the same as title hits, so a query that uses a synonym routes to the right template even when the canonical slug has no token overlap.

License

Apache 2.0