49 lines (31 loc) · 1.34 KB

Installation

Requirements

Linux, MacOS or Windows
Docker
Python3 (version 3.6 and above, 3.10+ recommended)

Linux/MacOS/Unix

Install Docker and Python3.

Make sure that the user running SmartBugs has permission to interact with the Docker daemon, by adding the user to the docker group:
```
sudo usermod -a -G docker $USER
```
For adding someone else, replace $USER by the respective user-id. The group membership becomes active with the next log-in.

Clone SmartBugs's repository:

git clone https://github.com/smartbugs/smartbugs

Install Python dependencies in a virtual environment:
```
cd smartbugs
install/setup-venv.sh
```
Optionally, add the executables to the command search path, e.g. by adding links to $HOME/bin.
```
ln -s "`pwd`/smartbugs" "$HOME/bin/smartbugs"
ln -s "`pwd`/reparse" "$HOME/bin/reparse"
ln -s "`pwd`/results2csv" "$HOME/bin/results2csv"
```
The command which smartbugs should now display the path to the command.

Windows

See our wiki page on running SmartBugs in Windows.