Skip to content
Snippets Groups Projects
Installation.md 1.68 KiB
Newer Older
selva's avatar
selva committed

selva's avatar
selva committed

selva's avatar
selva committed
# BiTIA Installation
selva's avatar
selva committed
BiTIA CLI is the Command Line Interface Tool that helps get 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

selva's avatar
selva committed

selva's avatar
selva committed
To Install **BiTIA** using pip, run this command:
selva's avatar
selva committed

selva's avatar
selva committed
<div id="termynal" data-termynal>
    <span data-ty="input">python3 -m pip install bitia</span>
    <span data-ty="progress"></span>
    <span data-ty>Successfully installed bitia</span>
</div>
selva's avatar
selva committed

selva's avatar
selva committed
## Configuration
selva's avatar
selva committed
TODO: Order of searching configuration file.
selva's avatar
selva committed
**_UNIX_**
selva's avatar
selva committed
                 
selva's avatar
selva committed
<div id="termynal" data-termynal>
selva's avatar
selva committed
    <span data-ty="input"> ./bitia.toml  </span>
    <span data-ty="input"> ~/.bitia.toml  </span>
    <span data-ty="input"> $HOME/.config/bitia.toml  </span>
    <span data-ty="input"> /etc/bitia.toml  </span>
selva's avatar
selva committed
</div>
                  
**_WINDOWS_**              
                    
 <div id="termynal" data-termynal>
    <span data-ty="input"> bitia.toml  </span>
    <span data-ty="input"> %APPDATA%\bitia.toml  </span>
    <span data-ty="input"> %PROGRAMDATA%\bitia.toml  </span>
</div>                 
selva's avatar
selva committed
<script type="text/javascript" src="https://raw.githack.com/tiangolo/fastapi/master/docs/en/docs/js/termynal.js" data-termynal-container="#termynal"></script>
selva's avatar
selva committed
           


selva's avatar
selva committed

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