Pitcher

Automatic README management for VS Code projects.

Pitcher is a VS Code extension that helps developers maintain project documentation by creating and updating README files based on project structure changes.

Instead of manually editing documentation whenever files are added, removed, or modified, Pitcher monitors the workspace and keeps the README synchronized with the project structure.

Features

Automatic README Creation

When a project does not contain a README.md file, Pitcher automatically generates one.

Project Monitoring

Pitcher watches the workspace for:

• File creation
• File deletion
• File modifications
• Folder changes

README Synchronization

Whenever the project structure changes, Pitcher updates the README file to reflect the latest structure.

Project Structure Documentation

Pitcher can generate documentation for:

• Folder structure
• Project files
• Source directories
• Configuration files

VS Code Integration

Pitcher works directly inside VS Code and integrates with the current workspace.

How It Works

Step 1

Open a project in VS Code.

Step 2

Pitcher checks whether a README.md file exists.

Step 3

If no README file is found, Pitcher creates one.

Step 4

Pitcher starts monitoring the workspace using file system watchers.

Step 5

When files or folders change, the README is updated automatically.

Example

Before

project/
├── src/
│   ├── App.jsx
│   └── Navbar.jsx

README:

# Project

Basic project documentation.

After Adding a File

project/
├── src/
│   ├── App.jsx
│   ├── Navbar.jsx
│   └── DarkMode.jsx

Updated README:

# Project

## Structure

src/
├── App.jsx
├── Navbar.jsx
├── DarkMode.jsx

Commands

Pitcher: Create README
Pitcher: Sync README
Pitcher: Refresh Documentation

Technology Stack

• TypeScript
• Node.js
• VS Code Extension API
• File System Watcher

Benefits

• Reduces manual README maintenance
• Keeps documentation aligned with project structure
• Improves project organization
• Works directly inside VS Code

Future Improvements

• Custom README templates
• Markdown formatting options
• Project statistics
• Changelog generation
• Git integration

License

MIT License

pitcher

Overview

pitcher is a VS Code Extension documented automatically by Pitcher.

Project Information

Technology Stack

• Node.js
• JavaScript
• VS Code Extension

Folder Structure

pitcher
├── vsc-extension-quickstart.md
├── test
│   └── extension.test.js
├── src
│   ├── utils
│   │   └── fileSystem.js
│   ├── parser
│   │   └── projectScanner.js
│   ├── images
│   │   ├── poster.png
│   │   └── pitcher-icon.png
│   ├── generator
│   │   └── readmeGenerator.js
│   └── extension.js
├── README.md
├── package.json
├── package-lock.json
├── CHANGELOG.md
├── .vscodeignore
├── .vscode-test.mjs
├── jsconfig.json
├── eslint.config.mjs
├── LICENSE.txt
└── .vscode
    ├── launch.json
    └── extensions.json

Features

• Automatic README generation
• Automatic README updates
• Technology stack detection
• Folder structure analysis
• Project statistics

Installation

git clone <repository-url>

cd pitcher

Statistics

Author

Generated by Pitcher

Pitcher Managed Last Updated: 19 / 06 / 2026 at 10:21 PM