BeClaude

literate-agent

New
GitHubDocumentationby jingtaozf

Literate-programming doctrine — rules, skills, hooks, and templates — packaged as a Claude Code plugin and as a CLAUDE.md-importable aggregator.

First seen 5/23/2026

Summary

The Literate Agent skill packages literate programming principles into a Claude Code plugin, providing rules, hooks, and templates for writing self-documenting, human-readable code.

  • It helps developers maintain clear documentation alongside their code, improving collaboration and code maintainability.

Install & Usage

1
Create the agents directory
mkdir -p .claude/agents
2
Save the agent file

Add the configuration to .claude/agents/literate-agent.md

3
Invoke with @agent-name
@literate-agent

Use Cases

Generate inline documentation that explains the purpose and logic of a code module as you write it.
Create a project README that automatically stays in sync with your codebase by extracting comments and docstrings.
Enforce a documentation standard across a team by applying literate programming templates to new files.
Refactor a legacy codebase by adding explanatory comments and structured documentation without changing functionality.
Produce a technical design document that weaves together code snippets and narrative explanations for a new feature.
Audit existing code for missing or outdated documentation and generate suggestions for improvement.

Usage Examples

1

/literate-agent document the main.py file in the current project with inline explanations for each function

2

Add literate programming comments to the authentication module, explaining the OAuth flow step by step

3

Generate a literate-style README.md for this project, extracting docstrings from all Python files

View source on GitHub
agentplugin

Security Audits

LicenseUnknownSourceWarnRepositoryPass

Frequently Asked Questions

What is literate-agent?

The Literate Agent skill packages literate programming principles into a Claude Code plugin, providing rules, hooks, and templates for writing self-documenting, human-readable code. It helps developers maintain clear documentation alongside their code, improving collaboration and code maintainability.

How to install literate-agent?

To install literate-agent: create the agents directory (mkdir -p .claude/agents), then add the config to .claude/agents/literate-agent.md. Finally, @literate-agent in Claude Code.

What is literate-agent best for?

literate-agent is a agent categorized under Documentation. It is designed for: agent, plugin. Created by jingtaozf.

What can I use literate-agent for?

literate-agent is useful for: Generate inline documentation that explains the purpose and logic of a code module as you write it.; Create a project README that automatically stays in sync with your codebase by extracting comments and docstrings.; Enforce a documentation standard across a team by applying literate programming templates to new files.; Refactor a legacy codebase by adding explanatory comments and structured documentation without changing functionality.; Produce a technical design document that weaves together code snippets and narrative explanations for a new feature.; Audit existing code for missing or outdated documentation and generate suggestions for improvement..