#CLI Reference

IndexBus ships three command-line tools for inspection, routing, and application scaffolding.

#indexbus-inspect

Inspect shared-memory regions from the command line. Output includes region kind, initialized state, layout version, capability bits, queue depths, and slot pool utilization.

#Human-Readable Output

cargo run -p indexbus-inspect -- /dev/shm/my_region

#Machine-Readable JSON

cargo run -p indexbus-inspect -- --json /dev/shm/my_region

#Journal Commands

# Dump all journal records
cargo run -p indexbus-inspect -- --journal-dump /dev/shm/my_journal

# Watch for new journal records (tail mode)
cargo run -p indexbus-inspect -- --journal-watch /dev/shm/my_journal

#indexbus-route

Run a standalone router process for a SHM fanout region.

cargo run -p indexbus-route -- \
    --path /dev/shm/my_region \
    --mode work \
    --policy drop

#Modes

#Policies

#Periodic Stats Output

The router prints periodic statistics to stdout:

sent/sec: 1200000  routed/sec: 1200000  delivered/sec: 1200000
recv/sec: 1200000  drops/sec: 0  qdepth: src_0 consumers=[0]

#Credit Flags

#indexbus-app

Application template with multi-process roles and platform wiring.

#Subcommands

Run each subcommand in a separate terminal for multi-process operation:

cargo run -p indexbus-app -- ingest
cargo run -p indexbus-app -- process --consumer-index 0
cargo run -p indexbus-app -- sink --consumer-index 0

#All-in-One Mode

Run all roles in a single process:

cargo run -p indexbus-app -- all --process-consumer-index 0 --sink-consumer-index 0

#Configuration Flags

The HTTP admin server exposes /healthz, /readyz, and /metrics (with the prometheus feature).