File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ ==============
2+ BrainFrame CLI
3+ ==============
4+
5+ The BrainFrame CLI is a tool for installing and managing a BrainFrame server.
6+
7+ Installation
8+ ------------
9+
10+ The CLI is installable with Pip. Ubuntu 18.04 and 20.04 are officially
11+ supported, but other versions of Linux are expected to work as well.
12+
13+ On Ubuntu:
14+
15+ .. code-block ::
16+
17+ sudo -H pip3 install brainframe-cli
18+
19+ Upgrading
20+ ---------
21+
22+ Pip can be used to upgrade to a new version.
23+
24+ .. code-block ::
25+
26+ sudo -H pip3 install --upgrade brainframe-cli
27+
28+ Usage
29+ -----
30+
31+ To install BrainFrame, simply run the ``install `` command as root:
32+
33+ .. code-block ::
34+
35+ sudo brainframe install
36+
37+ BrainFrame can then be controlled like a normal Docker Compose application
38+ using the ``compose `` command, which can be run from any directory.
39+
40+ .. code-block ::
41+
42+ brainframe compose up -d
43+
44+ For more information, take a look at the `Getting Started guide `_.
45+
46+ .. _`Getting Started guide` : https://aotu.ai/docs/getting_started/
You can’t perform that action at this time.
0 commit comments