Tools
CLI Commands
The kenate command-line tool is your developer multitool. Learn it, love it.
Available Commands
| Command | Purpose |
|---|---|
| kenate init | Create a new project |
| kenate build | Compile the C++ Engine |
| kenate run | Build and run your robot |
| kenate test | Run unit tests |
| kenate visualize | Launch the dashboard |
kenate init <name>
Creates a new project folder with the standard structure. Gets you from zero to robot in seconds.
$ kenate init my_robot Creating project: my_robot ✓ Created hardware.toml ✓ Created main.py ✓ Created states/ ✓ Created tests/ ✓ Created virtualenv Done! cd my_robot to get started.
kenate build
Runs CMake and compiles the C++ Engine. Links the Python bindings. You only need to do this once (usually).
$ kenate build Configuring CMake... Compiling C++ Engine... Linking Python bindings... ✓ Build complete: kenate_bindings.pyd
kenate run
Builds (if needed) and executes your main.py. The main event.
$ kenate run ✓ Build up-to-date Starting Engine... [INFO] Entered state: Idle [INFO] Starting patrol...
kenate test
Runs your unit tests using a mock engine (no real hardware needed). Test early, test often.
$ kenate test Running tests/test_patrol.py... ✓ test_enters_alert_on_obstacle ✓ test_moves_forward_when_clear 2 passed, 0 failed
kenate visualize
Starts a WebSocket server and opens the real-time dashboard at localhost:3000. See what your robot sees.
$ kenate visualize Starting WebSocket server on :8080 Opening dashboard at http://localhost:3000 Connected to robot!