Skip to content
Snippets Groups Projects

Update Documentation

Merged Selvaganapathy Kannan requested to merge 5-enable-docs into main
Files
6
# BiTIA Installation
BiTIA CLI is the Command 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.
# BiTIA
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.
**To work with BiTIA, we need to install bitia-cli and submit tasks to the server**
## Installing bitia
BiTIA CLI is available on [PyPi] as [BiTIA].
Installing bitia is very simple, you only need to have [python-pip] installed in your system
BiTIA CLI is available on [PyPi] as [BiTIA].
Ensure you have a working pip with python installed. You can accomplish this by executing the following commands and confirming that the output looks similar
To Install **BiTIA** using pip, run this command:
``` bash
$ python --version
Python 3.N.N
$ pip --version
pip X.Y.Z from ... (python 3.N.N)
```
If that worked, congratulations! You have a working pip in your environment.
```{eval-rst}
.. tabs::
.. group-tab:: Unix
.. code-block:: bash
$ python3 -m pip install bitia
.. group-tab:: Windows
.. code-block:: bash
$ python3 -m pip install bitia
```
**Configuration**
TODO: Order of searching configuration file.
To Install **BiTIA** using pip, run this command:
```{eval-rst}
.. tabs::
.. tab:: Linux
$ python3 -m pip install bitia
.. group-tab:: Unix
.. tab:: MacOS
.. code-block:: bash
$ python3 -m pip install bitia
1. ./bitia.toml
2. ~/.bitia.toml
3. $HOME/.config/bitia.toml
4. /etc/bitia.toml
.. tab:: Windows
.. group-tab:: Windows
.. code-block:: bash
$ python3 -m pip install bitia
1. bitia.toml
2. %APPDATA%\bitia.toml
3. %PROGRAMDATA%\bitia.toml
```
[BiTIA]: https://pypi.org/project/bitia/
[Pypi]: https://pypi.org/
[install Python]: https://realpython.com/installing-python/
[python-pip]: https://pypi.org/project/pip/
\ No newline at end of file
Loading