This repository contains comprehensive professional guidelines and rules for developing SketchUp Ruby API extensions. These rules are carefully compiled and distilled from official SketchUp repositories, Ruby API documentation, and community best practices. It is specifically optimized for both AI assistants (ChatGPT, Claude, Copilot, Cursor, etc.) and human developers.
If you are an AI assistant (Cursor, Copilot, Cline, Antigravity, etc.) and you have been asked to write, review, or debug a SketchUp extension, you MUST first read the sketchup_api_skill.md file and STRICTLY FOLLOW the rules within it.
You can use this repository to ensure that your AI assistants write professional code that complies with SketchUp Extension Warehouse standards. Methods to integrate this into your workflow:
- Cursor IDE: Add the contents of
sketchup_api_skill.mdto your project's.cursorrulesfile or invoke it as@sketchup_api_skill.md. - ChatGPT / Claude: When generating plugins, paste the contents of the MD file into your prompt, Custom Instructions, or Project Knowledge.
- GitHub Copilot: You can add the content as
.github/copilot-instructions.md.
sketchup_api_skill.md: The main rule set explaining all professional SketchUp Ruby API best practices with correct (✅) and incorrect (❌) code examples.
We want to enrich this repository with contributions from the community. Please check the CONTRIBUTING.md file for details on how to add new rules.
Fırat Kılavuz
Architect | Landscape Architect | MSc Student at ITU | Plugin Developer
- Email: firatclaus@gmail.com
- GitHub: @euphraetes
- SketchUp Forum: euphraetes
- Tools: Paralaks Tools on Extension Warehouse