🧠 Setupscribe - VS Code Dev Assistant

Setupscribe is a lightweight, intelligent developer assistant built as a VS Code extension. It captures real-time terminal commands you run during project setup or configuration and automatically generates a clean, markdown-formatted setup guide using LLMs like OpenAI.

🚀 Why Setupscribe?

Writing or updating README.md setup instructions is often tedious and overlooked. Setupscribe removes that friction by:

• Capturing actual setup/build/test commands while you work
• Automatically converting them into a professional project guide
• Helping with new developer onboarding, project handovers, and closure documentation

✨ Key Features

• 🖥️ Run and log setup commands directly inside VS Code
• 🧼 Clear previously logged commands
• 📘 Generate a setup-guide.md based on your commands using OpenAI
• 🔁 Seamless integration into your existing development workflow

🧩 How It Works (MCP Integration)

Setupscribe follows the Model Context Protocol (MCP) pattern:

1. Input Context: Captures commands you run (e.g., npm install, git clone, cd project)
2. Structured Storage: Logs commands to a JSON file inside VS Code extension storage
3. LLM Reasoning: Passes logged commands as context to OpenAI to intelligently generate documentation
4. Output: A human-readable, markdown setup guide saved to your current workspace

🛠 Usage

After installing the extension:

🎯 Available Commands

Use the Command Palette (Cmd/Ctrl + Shift + P):

• Setupscribe: Run and Log Command – run a terminal command and log it
• Setupscribe: Generate Setup Guide – generate markdown setup-guide from logs
• Setupscribe: Clear Logged Commands – reset current session log

📝 Example Flow

1. Open a folder in VS Code
2. Run Setupscribe: Run and Log Command, type: npm install
3. Run another: npm run dev
4. Run Setupscribe: Generate Setup Guide
5. 🎉 setup-guide.md appears in your project root

📦 Tech Stack

• TypeScript
• VS Code Extension API
• OpenAI GPT-4 (via openai npm package)

📸 Screenshots

• Before: Unstructured terminal commands
• After: setup-guide.md with categorized, documented steps

📈 Future Scope

• Passive background terminal listener (no need to use command palette)
• Support for terminal session annotation (e.g., "this is a dev script")
• Auto-sync with project README or wiki docs

🧪 Dev Setup

git clone https://github.com/yourusername/setupscribe
cd setupscribe
npm install
npm run compile
code .
# Press F5 to launch Extension Host

🙌 Acknowledgements

Inspired by the MCP Hackathon: "Build AI assistants that know your stack"

---

🛠️ Built with ❤️ during Dev Hackathon July 2025