See Help & Usage Guide →

Visual thinking for coding with AI. Sketch ideas and use them in your prompts to improve your workflow with AI models. Works in OpenVSX-compatible editors like Cursor, Windsurf, Firebase Studio, etc.

Website: https://sketch-prompt.com

• Multi-Editor Support: Works in any OpenVSX-compatible editor (Cursor IDE, Windsurf, Google Firebase Studio, etc.)
• Rich Sketching: Draw, doodle, and map out your ideas with intuitive tools—just like pen and paper, but smarter
• Copy to Prompt: Copy your sketch with a click and drop it straight into your next AI conversation
• Privacy-First: Local processing with no data collection or cloud dependencies. Your sketches stay on your machine
• Persistent Sketches: Your sketches are always saved and organized, ready to revisit, remix, or share anytime
• Smart Auto-Save: Your work is automatically saved as you sketch with optimized timing
• Reliable File Handling: Robust error recovery and file validation to keep your work safe
• AI-Ready Format: Structured data that can be version controlled and analyzed by AI
• Open Source: Transparent, auditable code with regular security reviews

SketchPrompt is distributed via the OpenVSX registry and works in any OpenVSX-compatible editor:

• Cursor IDE - Full support with all features
• Windsurf - Full support with all features
• Google Firebase Studio - Full support with all features
• Any OpenVSX-compatible editor - Full support

All editors use the same installation process:

1. Open your editor's extension marketplace
2. Search for "SketchPrompt"
3. Click Install

All features work identically across all supported editors:

• Sketching canvas and tools
• File persistence and auto-save
• Copy to prompt functionality
• Custom .sketchprompt file editor
• Command palette integration

Install SketchPrompt from your editor's extension marketplace:

1. Open your OpenVSX-compatible editor (Cursor IDE, Windsurf, Google Firebase Studio, etc.)
2. Go to Extensions (Cmd/Ctrl + Shift + X)
3. Search for "SketchPrompt"
4. Click Install

Build from source to contribute or customize:

1. Clone this repository: git clone https://github.com/pascalx-git/SketchPrompt.git
2. Install dependencies: npm install
3. Build the extension: npm run vscode:prepublish
4. Package the extension: npx vsce package
5. Install the .vsix file in any OpenVSX-compatible editor

Alternative: Visit https://sketch-prompt.com for detailed tutorials and documentation.

• Open the command palette (Cmd/Ctrl + Shift + P)
• Run "SketchPrompt: New Sketch"
• Or right-click in the file explorer and select "SketchPrompt: New Sketch"
• A new .sketchprompt file will be created in the SketchPrompt folder
• The file will open in the SketchPrompt editor

Works in any OpenVSX-compatible editor

• Open any .sketchprompt file to edit it visually
• All changes are auto-saved

• .sketchprompt files are automatically opened in the SketchPrompt editor
• Smart Auto-Save: Only saves when content actually changes with optimized timing (1-10 second intervals)
• File Watching: Automatically reloads when files are modified externally
• JSON Format: Files contain structured data that can be version controlled and analyzed by AI
• Visual Feedback: Real-time status updates and notifications keep you informed
• Smart Recovery: Automatic backup and recovery from file corruption
• Enhanced Error Handling: Robust file path validation with user-friendly error messages
• Performance Monitoring: Save frequency tracking and status bar indicators

• Help: Run "SketchPrompt: Help" from the command palette to open the local Help.md file
• Feedback: Run "SketchPrompt: Share Feedback" to share your thoughts and suggestions or visit our feedback survey
• Documentation: Visit https://sketch-prompt.com for detailed tutorials and documentation
• GitHub: Check the GitHub repo for the latest updates and issues

We value your feedback! It helps us improve SketchPrompt for everyone.

# Build the webview (React app)
npm run build-webview

# Build the extension
npm run compile

# Build both
npm run vscode:prepublish

# Watch webview changes
npm run watch-webview

# Watch extension changes
npm run watch

1. Press F5 in any OpenVSX-compatible editor to launch the extension in debug mode
2. Create a new sketch and test the functionality
3. Check the developer console for any errors

• Extension: TypeScript-based extension for OpenVSX-compatible editors (Cursor IDE, Windsurf, Firebase Studio, etc.)
• Webview: React app with TLDraw integration
• Build: Vite for webview bundling, TypeScript for extension compilation
• Auto-Save: Debounced, content-aware saving with deep equality checks
• File Watching: Self-trigger suppression to prevent reload loops

SketchPrompt is built with security-first principles to ensure your sketches and workflow remain safe and private.

• Local-First Architecture: All sketches stay on your machine with no cloud dependencies
• Open Source & Auditable: Full source code available for security review
• Privacy-Focused: No data collection or transmission to external services
• Regular Security Reviews: Iterative assessments before each release

• No personal data tracking: We don't collect user names, emails, or identities
• No sketch content transmission: Your drawings never leave your machine
• No file monitoring: Individual file names or workspace data are not tracked
• Local processing: All functionality runs locally on your device

📋 See detailed security information →

• Content Security Policy (CSP): Hardened against XSS attacks
• Input Validation: All sketch data validated with JSON schema
• Path Traversal Protection: Secure file operations
• Error Sanitization: No information leakage in error messages
• Local Bundling: Minimal external dependencies

SketchPrompt is designed with privacy in mind. All sketch data stays on your local machine and is never sent to external services.

What We Don't Track:

• ❌ Personal data: No user names, emails, or identities
• ❌ Sketch content: Your drawings and sketches are never sent anywhere
• ❌ File names: Individual file names or paths are not tracked
• ❌ Workspace data: Your project structure or workspace information
• ❌ AI conversations: Chat content or prompts are not tracked

What's Coming:

• 🔒 Local-first approach: All features will prioritize local processing
• 🤝 Optional collaboration: Future sharing features will be opt-in only
• 🔐 End-to-end encryption: For any future cloud features
• 📊 Privacy-focused analytics: If implemented, will be anonymous and optional

• Stabilizing the core sketching experience
• Improving auto-save reliability and performance
• Enhancing the file format for better AI integration
• Robust error handling and file path validation

• Integrating AI capabilities to analyze sketches
• Generate prompts and provide intelligent suggestions
• AI-powered content analysis based on visual content

• Multi-user sketching with real-time synchronization
• Conflict resolution and version control
• Cloud-based sharing capabilities

• tldraw: Rich sketching library
• react & react-dom: UI framework
• vite: Build tool for the webview
• typescript: Extension development

MIT

SketchPrompt is licensed under the MIT License. This project bundles the TLDraw SDK, which is licensed separately by tldraw, Inc. and is subject to its own terms. By using SketchPrompt, you agree to comply with both the MIT License and the TLDraw SDK License.

• See LICENSE file for full details
• TLDraw SDK License

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test thoroughly in any OpenVSX-compatible editor
5. Submit a pull request

We love hearing from our users! Your feedback helps us make SketchPrompt better for everyone.

• In-Extension: Run "SketchPrompt: Share Feedback" from the command palette
• Website: Visit https://sketch-prompt.com for detailed documentation
• GitHub: Report issues or suggest features on GitHub

• How you're using SketchPrompt in your workflow
• Features that would make it more useful
• Any issues or bugs you encounter
• General experience and satisfaction

• Website: https://sketch-prompt.com
• GitHub: https://github.com/pascalx-git/SketchPrompt
• Help: Run "SketchPrompt: Help" in any OpenVSX-compatible editor or see Help.md
• Contact: hey@sketch-prompt.com
• YouTube: https://www.youtube.com/@SketchPrompt

Version: 0.2.4 | Last Updated: July 31 2024 | Compatibility: OpenVSX-compatible editors