A simple to use Command Line Interface that allows access to AimBrain's API endpoints
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
aimbrain
.gitignore
LICENSE
MANIFEST.in
README.md
setup.cfg
setup.py

README.md

aimbrain-cli

aimbrain-cli is a simple to use Command Line Interface that allows you to access AimBrain's API endpoints quickly and easily.

Getting Started

For a full setup and usage guide please see https://aimbrain.github.io/aimbrain-api/?shell#setup-the-aimbrain-cli

In order to install the CLI locally (on Linux), just clone the repo and:

virtualenv /path/to/envs/aimbrain-cli
source /path/to/envs/aimbrain-cli/bin/activate
pip install .

You may wish to move the aimbrain-cli binary to /usr/local/bin.

However, if you wish to do some dev work on it, it is recomended to run the following:

virtualenv /path/to/envs/aimbrain-cli
source /path/to/envs/aimbrain-cli/bin/activate
pip install --editable .

Instrucutions on how to use can be found by running:

aimbrain-cli --help

And see Python DocOpt docs for details on how to add new commands etc:

https://github.com/docopt/docopt