Skip to content

Latest commit

 

History

159 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GroKi


AI-powered KiCad schematic intelligence. GroKi transforms complex hardware schematics into interactive, AI-explained experiences. Upload any KiCad project and get instant component analysis, circuit explanations, and part recommendations—all powered by Grok AI.

⭐️ Features

  • Interactive visualization: WebGL-based schematic viewer with pan, zoom, and component highlighting
  • AI-powered analysis: Grok integration for component explanations and circuit understanding
  • Smart part search: Integrated DigiKey OAuth search with obsolescence detection
  • Edge-deployed: Globally distributed on Cloudflare Workers for low-latency access
  • Zero dependencies: Lightweight TypeScript viewer, no React or heavy frameworks

🚀 Quickstart

Prerequisites

  • Bun (for development)
  • Node.js 18+ (if not using Bun)

Run locally

cd web
bun install
bun run dev
# Open http://localhost:8787

Build for production

cd web
bun run build

🌐 Deployment

Deploy to Cloudflare Workers

cd web
bunx wrangler deploy --env production

Beta Environment

bunx wrangler deploy --env beta
# Deployed to beta.grokicad.com

📦 Project Structure

grokicad/
├── web/               # TypeScript frontend & Cloudflare Worker
│   ├── src/           # Viewer implementation (KiCanvas-based)
│   ├── worker/        # Cloudflare Worker (OAuth, API proxy)
│   └── wrangler.jsonc # Deployment configuration
├── kicad-example-files/  # Demo KiCad projects
│   ├── BMS/          # Battery management system
│   └── Smart Watch/  # Smartwatch hardware
└── grokprompts/     # AI system prompts

🧪 Example Projects

Try these included KiCad projects:

  • uBMS-2: Battery management system with multiple sheets
  • Smart Watch: Complete smartwatch hardware design

Both are in kicad-example-files/ for instant demos.

🤝 Contributing

We welcome contributions! Please open an issue or PR on GitHub.

👥 Team

🙏 Acknowledgments

Built on:

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.


Made with ❤️ for the hardware community

About

Grok powered schematic intelligence for your kicad repositories

Resources

Stars

25 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages