Back to Ruview

ruv-neural-cli

rust-port/wifi-densepose-rs/crates/ruv-neural/ruv-neural-cli/README.md

0.7.03.6 KB
Original Source

ruv-neural-cli

CLI tool for brain topology analysis, simulation, and visualization.

Overview

ruv-neural-cli is the command-line binary (ruv-neural) that ties together the entire rUv Neural crate ecosystem. It provides subcommands for simulating neural sensor data, analyzing brain connectivity graphs, computing minimum cuts, running the full processing pipeline with an optional ASCII dashboard, and exporting to multiple visualization formats.

Installation

bash
# Build from source
cargo install --path .

# Or run directly
cargo run -p ruv-neural-cli -- <command>

Commands

simulate -- Generate synthetic neural data

bash
ruv-neural simulate --channels 64 --duration 10 --sample-rate 1000 --output data.json
FlagDefaultDescription
-c, --channels64Number of sensor channels
-d, --duration10.0Duration in seconds
-s, --sample-rate1000.0Sample rate in Hz
-o, --output(none)Output file path (JSON)

analyze -- Analyze a brain connectivity graph

bash
ruv-neural analyze --input graph.json --ascii --csv metrics.csv
FlagDefaultDescription
-i, --input(required)Input graph file (JSON)
--asciifalseShow ASCII visualization
--csv(none)Export metrics to CSV file

mincut -- Compute minimum cut

bash
ruv-neural mincut --input graph.json --k 4
FlagDefaultDescription
-i, --input(required)Input graph file (JSON)
-k(none)Multi-way cut with k partitions

pipeline -- Full end-to-end pipeline

bash
ruv-neural pipeline --channels 32 --duration 5 --dashboard

Runs: simulate -> preprocess -> build graph -> mincut -> embed -> decode.

FlagDefaultDescription
-c, --channels32Number of sensor channels
-d, --duration5.0Duration in seconds
--dashboardfalseShow real-time ASCII dashboard

export -- Export to visualization format

bash
ruv-neural export --input graph.json --format dot --output graph.dot
FlagDefaultDescription
-i, --input(required)Input graph file (JSON)
-f, --formatd3Output format: d3, dot, gexf, csv, rvf
-o, --output(required)Output file path

info -- Show system information

bash
ruv-neural info

Displays crate versions, available features, and system capabilities.

Global Options

FlagDescription
-vIncrease verbosity (up to -vvv)
--versionPrint version
--helpPrint help

Integration

Depends on all workspace crates: ruv-neural-core, ruv-neural-sensor, ruv-neural-signal, ruv-neural-graph, ruv-neural-mincut, ruv-neural-embed, ruv-neural-memory, ruv-neural-decoder, and ruv-neural-viz. Uses clap for argument parsing and tokio for async runtime.

License

MIT OR Apache-2.0