CBRAIN CLI

A command-line interface to a CBRAIN service

This repository contains a UNIX command-line interface (CLI) for CBRAIN.

The interface is implemented in Python using only standard libraries - no external dependencies required.

The main command is called "cbrain" and as is typical for such clients, works with a set of subcommand and options (e.g. "cbrain file list -j") such as:

cbrain file list
cbrain project show
cbrain --json dataprovider list

Prerequisites

Before using this CLI, you need to have a CBRAIN service running locally. Follow the setup instructions at:

• CBRAIN GitHub Repository

Installation

This CLI tool uses pure Python with no external library dependencies, making installation straightforward.

Option 1: Direct Usage

1. Clone this repository:

   git clone https://github.com/aces/cbrain-cli.git
   cd cbrain-cli

2. Run directly:

   ./cbrain --help # Make the cbrain script executable by `chmod +x cbrain`

Option 2: Virtual Environment

For isolated usage:

# Create and activate virtual environment
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e .
cbrain login

API Reference

This CLI interfaces with the CBRAIN REST API. For complete API documentation and specifications, refer to:

• CBRAIN API Documentation (Swagger)

Development

This is part of a GSoC (Google Summer of Code) project sponsored by INCF.

The lead developer is axif0, mentored by the developers of the CBRAIN project.

License

See LICENSE file for details.