clankers-cli 0.1.1

Command-line interface for clankeRS
clankers-cli-0.1.1 is not a library.
Visit the last successful build: clankers-cli-0.1.6

Scaffold projects, replay MCAP logs, validate ONNX models, and run the camera-perception demo — the clankers binary for day-to-day robotics workflows.

Install

cargo install clankers-cli
clankers --help

Quick start

# New project from a template
clankers new my_robot --template perception-node
cd my_robot
clankers run

# Inspect and replay a log
clankers inspect sample_data/camera_log.mcap
clankers replay sample_data/camera_log.mcap

# Validate ONNX against stored PyTorch references
clankers validate-model \
  --onnx sample_data/models/detector.onnx \
  --samples sample_data/detector_inputs

# Golden-path demo (MCAP → ONNX → detections)
clankers demo camera-perception

Commands

Command Purpose
new Scaffold from basic-node, perception-node, ml-inference-node, or replay-test-node
run Run the current project's node
test Run replay tests and cargo test
inspect Summarize an MCAP file
replay Replay a log (optionally through a node)
latency Latency stats from a replay
compare Diff two MCAP files
validate-model ONNX vs PyTorch reference outputs
import-pytorch Export a checkpoint to ONNX
add-model Register a model in clankeRS.toml
visualize MCAP summary for Foxglove / Rerun
demo Run bundled demos (camera-perception)
record MCAP recording (stub in v0.1)

Learn more

License

MIT — see LICENSE.