Skip to content

CLI Overview

BMTool provides a command-line interface (CLI) that makes many of its features accessible without writing Python code.

Basic Usage

To see all available commands:

bmtool --help

Usage: bmtool [OPTIONS] COMMAND [ARGS]...

Options:
  --verbose  Verbose printing
  --help     Show this message and exit.

Commands:
  debug
  plot
  util

Structure

The CLI is organized into three main groups:

  • plot: Visualization tools for network simulations (raster plots, connections, positions).
  • util: Utility tools for cell tuning, characterization, and building.
  • debug: Debugging utilities for simulation configurations.

Within util, additional subgroups include:

  • cell: Single-cell tuning and characterization workflows.
  • synapse: Desktop GUI tools for synapse tuning from config-driven models.