explaingit

medadembha/docflow

17ShellAudience · developerComplexity · 2/5LicenseSetup · easy

TLDR

A set of Bash scripts that scaffolds a seven-folder documentation structure inside any code repository so AI coding agents like Claude, Cursor, and Codex start every session knowing what recently shipped and where everything lives.

Mindmap

mindmap
  root((docflow))
    What it does
      Scaffolds doc folders
      Generates INDEX.md
      Creates AGENTS.md
    Folders created
      product-spec
      specs
      decisions
      changelog
    Integrations
      Claude Code plugin
      Codex plugin
      Gemini and Cursor
    Setup
      Doctor script first
      Bash only
      No database
    Tech stack
      Shell
      Bash
      Markdown
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Set up a documentation structure in your repo so AI agents like Claude Code or Codex start every session knowing what recently shipped and where everything lives.

USE CASE 2

Install the Claude Code SessionStart hook so every new conversation automatically prints the docs map and latest changelog entry.

USE CASE 3

Run the doctor script to get advice on whether to initialize fresh docs, adopt around existing ones, or repair previously generated files.

Tech stack

ShellBashMarkdown

Getting it running

Difficulty · easy Time to first run · 5min
Use, copy, modify, and distribute freely for any purpose including commercial use, with the original copyright notice kept.

In plain English

docflow is a lightweight tool for setting up structured documentation in a code repository so that AI coding agents like Claude, Codex, Gemini, or Cursor have useful project context when starting a new session. The idea is that AI agents work better when they can read a clear map of what a project does, how it is built, why certain decisions were made, and what recently changed, rather than inferring all of this from code alone. Running the scaffold script creates a seven-folder documentation structure inside your repository. Each folder covers a specific question: product-spec (what a feature does for users), specs (how it is built), decisions (why a choice was made), references (rules and conventions), plans (roadmap and current work), reviews (quality audits and known bugs), and changelog (what shipped each month). The tool also generates an INDEX.md that acts as a compact path-to-purpose map agents read first, and an AGENTS.md file that tells repo-aware agents where to find everything. There is a read-only SessionStart hook for Claude Code that automatically prints the docs map and the most recent changelog entry at the start of each new session, so the agent begins each conversation already knowing what recently shipped and where documentation lives. The tool can be installed as a plugin inside Claude Code or Codex, used via scaffold script with Gemini or Cursor, or run directly through the included Bash scripts with no agent integration at all. Before any setup it runs a doctor script that inspects the target repository and recommends whether to initialize from scratch, adopt around existing docs, or repair previously generated files. Everything is plain Markdown and Bash scripts. There is no database, no hosted service, and no subscription. The README is explicit that this is not a document-approval or e-signature tool. The project is MIT-licensed, written primarily in Shell, and has 17 stars on GitHub. The README describes it as an early MVP developer tool.

Copy-paste prompts

Prompt 1
I just ran the docflow scaffold script in my repo. Help me fill out the specs and decisions folders for my current feature, starting with the authentication module.
Prompt 2
I want to install docflow as a Claude Code plugin. Walk me through the exact commands to register it and verify the SessionStart hook is working.
Prompt 3
Using my docflow INDEX.md as context, write a changelog entry for the feature I shipped this week: [paste your feature notes here].
Prompt 4
My docflow doctor script says to adopt around existing docs. What does that mean and how do I do it without losing my current documentation?
Open on GitHub → Explain another repo

← medadembha on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.