Welcome to the GCodeKit5 User Guide. This documentation covers all features of GCodeKit5, a modern CNC machine controller and CAM suite.
Version: 0.50.2-alpha.0
- Introduction — What is GCodeKit5 and who is it for
- Installation — Installing on Linux, macOS, and Windows
- Quick Start — Get up and running in 5 minutes
- Device Setup — Serial, TCP/IP, and WebSocket connections
- Supported Controllers — GRBL, grblHAL, TinyG, g2core, FluidNC, Smoothieware
- Troubleshooting Connections — Common connection issues
- Machine Control — DRO, jogging, homing, WCS, and overrides
- Overrides — Feed rate, spindle speed, and rapid overrides
- Console — Device console and command entry
- Streaming G-Code — Sending programs to your machine
- G-Code Editor — Editing, syntax highlighting, and search
- Toolpath Visualizer — 3D toolpath preview and stock removal
- Designer Overview — Drawing shapes, importing files, generating toolpaths
- CAM Tools Overview — All built-in G-code generators
- Tool Library & Materials — Managing tools and material database
- Application Settings — Preferences and configuration
- Safety & Diagnostics — E-Stop, interlocks, communication health
- Help System — Built-in help browser
- Keyboard Shortcuts Reference — Complete shortcuts list
- FAQ — Frequently asked questions
- Glossary — CNC terminology
| I want to... | Go to... |
|---|---|
| Connect my CNC machine | Device Setup |
| Jog my machine manually | Machine Control |
| Open and edit G-code | G-Code Editor |
| Preview my toolpath | Toolpath Visualizer |
| Design a part from scratch | Designer Overview |
| Make a box with finger joints | CAM Tools |
| Engrave an image with my laser | CAM Tools |
| Run a G-code program | Streaming G-Code |
| Fix a connection problem | Troubleshooting |
| Configure keyboard shortcuts | Shortcuts Reference |
- Built-in Help: Use the Help menu or press the Help button on any panel
- GitHub Issues: Report bugs or request features
- Discussions: Ask questions and share ideas
- Email: tim.thawkins@gmail.com