⌘

Auto Documenter

Name: Auto Documenter
Author: scribe-ai

v1.2.3🛡️Tier 1 Security AuditedCLI v2.1.287+ Verified

Synchronizes README, JSDoc, and CHANGELOG entries upon turn completion based on verified AST diffs.

@scribe-ai•★1,390 stars•↓6,100 active installs•MIT License

View Source ↗

⚡Installation Specifier

$/plugin install auto-documenter@marketplace

Problem Solved & Architectural Motivation

Detects exported TypeScript signatures, new routes, and changed API parameters, automatically generating and updating docstrings and release notes before git staging.

Before Execution

Zero-Time AST Interception

Evaluates tool payloads prior to kernel fork.

Scoring Model

0-100 Impact Index

Weighted heuristic scoring: files touched, git dirty state, env scope.

Non-Intrusive

Native CLI Hook

Zero proxy daemon required; hooks straight into Claude tool calls.

Lifecycle Architecture & Hook Flow

POSIX Event Engine

Step 01

Claude Plan

Prompt Inference

→

Step 02

Tool Call

tool.call Payload

→

HOOK INTERCEPT

auto-documenter

<18ms Heuristic

→

Step 04

OS Execution

Kernel Fork

Manifest Schema (plugin.json)

{
  "name": "auto-documenter",
  "version": "1.2.3"
}

Hook Implementation (register.js)

TypeScript SDK

export default function doc(app) {
  app.on('session.end', async ({ modifiedFiles, generateChangelogEntry }) => {
    if (modifiedFiles.length > 0) {
      await generateChangelogEntry('CHANGELOG.md');
    }
  });
}

Security Audit94/100

Network EgressNone (Zero Socket Egress)

Filesystem ScopeBounded to Workspace

Credential Exposure0 Leaks Detected

Sandbox IsolationHost User Privilege