Skip to content
Snippets Groups Projects
Installation.md 1.45 KiB
Newer Older
selva's avatar
selva committed
# BiTIA Installation
selva's avatar
selva committed
BiTIA CLI is the Command Line Interface Tool which helps in getting user inputs with commands, directories and required files. It sends tasks to the server, where bitia-runner processes them and generates results.
selva's avatar
selva committed

selva's avatar
selva committed
**To work with BiTIA, we need to install bitia-cli and submit tasks to the server**
selva's avatar
selva committed
## Installing bitia
BiTIA CLI is available on [PyPi] as [BiTIA].

selva's avatar
selva committed
Installing bitia is very simple, you only need to have [python-pip] installed in your system
selva's avatar
selva committed
To Install **BiTIA** using pip, run this command:
selva's avatar
selva committed

selva's avatar
selva committed
  ```{eval-rst}
  .. tabs::

selva's avatar
selva committed
    .. group-tab:: Unix
selva's avatar
selva committed

              ..  code-block:: bash
                      
                     $ python3 -m pip install bitia


    .. group-tab:: Windows
              ..  code-block:: bash
                     
                     $ python3 -m pip install bitia
  ```
selva's avatar
selva committed
**Configuration**
selva's avatar
selva committed
TODO: Order of searching configuration file.
selva's avatar
selva committed
  ```{eval-rst}
  .. tabs::

selva's avatar
selva committed
    .. group-tab:: Unix
selva's avatar
selva committed

              ..  code-block:: bash
selva's avatar
selva committed

selva's avatar
selva committed
                  1. ./bitia.toml  
                  2. ~/.bitia.toml  
                  3. $HOME/.config/bitia.toml  
                  4. /etc/bitia.toml

    .. group-tab:: Windows
           
              ..  code-block:: bash

                     1. bitia.toml
                     2. %APPDATA%\bitia.toml
                     3. %PROGRAMDATA%\bitia.toml
  ```
selva's avatar
selva committed

[BiTIA]: https://pypi.org/project/bitia/
[Pypi]: https://pypi.org/
[python-pip]: https://pypi.org/project/pip/