BrainMaps CLI

The CLI prepares and uploads data, runs registration locally, and connects a compute machine to the platform’s job queues. The website provides catalogue browsing, interactive viewing and review.

Get started

  1. Install the current source checkout. Public PyPI distribution is not available as of 17 September 2026.
  2. Configure the API and sign in.
  3. Choose an upload workflow.
  4. Create a brain from the upload.
  5. Use registration or workers for processing.
brainmaps --help
brainmaps upload image --help
brainmaps register run --help

The current entry point is a command-line application. Interactive registration wizards use --interactive on the registration commands; there is no global --visual mode.

See the CLI reference for command groups, configuration and known limitations.

BrainMaps Documentation