PUG – Pure UpGrade

Docs, diagrams, and upgrade guides, built right into your IDE. Built-in export support to Confluence, Notion, and more.

Go to www.getpug.dev for more info!

What PUG Does

• Build package upgrade guides and generate cursor rules that prevent AI hallucinations and breakage
• Auto-generate diagrams (flowcharts, ER diagrams, and more)
• Generate technical documentation from your codebase with a few clicks
• Create feature-level docs that trace logic across files and libraries
• Use built-in or custom templates to standardize documentation
• Export to Notion, Confluence, PDF or HTML

Quick Start

1. Install the extension in your IDE
2. Open PUG using one of these methods:
   • Command Palette: Ctrl+Shift+P (or Cmd+Shift+P on macOS) then type "PUG"
   • Keyboard shortcut: Ctrl+Shift+D
3. Click on Configure PUG and paste your PUG API Key (You can create a new API key at www.getpug.dev)
4. Generate Documentation / Diagrams
5. Review the output in .cursor/rules

Privacy

PUG does not store or share your code. Documentation is generated locally and sent securely to Anthropic's Claude API for processing. Claude does not train on your data.

IDE Support

PUG is currently optimized for Cursor. However, you can manually configure the output directory for VS Code, Windsurf, or other IDEs using the inbuilt configuration menu.

Why We Built PUG

We were tired of AI breaking things during upgrades — and spending hours documenting code that already existed. PUG solves both by giving your tools the context they need and making documentation feel lightweight and integrated.

Co-founders: Purav Patel and Janani Prasad
contact@getpug.dev

You can also leave feedback directly through the PUG Help → Feedback form inside the extension.