Metadata-Version: 2.1
Name: brainframe-cli
Version: 0.1.5
Summary: Makes installing and managing a BrainFrame server easy
Home-page: https://github.com/aotuai/brainframe_cli
License: BSD-3-Clause
Author: Aotu
Author-email: info@aotu.ai
Requires-Python: >=3.6
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: distro (>=1.5,<2.0)
Requires-Dist: packaging (>=20.4,<21.0)
Requires-Dist: python-i18n (>=0.3,<0.4)
Requires-Dist: pyyaml (>=5.3,<6.0)
Project-URL: Repository, https://github.com/aotuai/brainframe_cli
Description-Content-Type: text/x-rst

==============
BrainFrame CLI
==============

The BrainFrame CLI is a tool for installing and managing a BrainFrame server.

Installation
------------

The CLI is installable with Pip. Ubuntu 18.04 and 20.04 are officially
supported, but other versions of Linux are expected to work as well.

On Ubuntu:

.. code-block::

    sudo -H pip3 install brainframe-cli

Upgrading
---------

Pip can be used to upgrade to a new version.

.. code-block::

    sudo -H pip3 install --upgrade brainframe-cli

Usage
-----

To install BrainFrame, simply run the ``install`` command as root:

.. code-block::

    sudo brainframe install

BrainFrame can then be controlled like a normal Docker Compose application
using the ``compose`` command, which can be run from any directory.

.. code-block::

    brainframe compose up -d

For more information, take a look at the `Getting Started guide`_.

.. _`Getting Started guide`: https://aotu.ai/docs/getting_started/

