> For the complete documentation index, see [llms.txt](https://vigil.deadbits.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vigil.deadbits.ai/overview/install-vigil.md).

# Install Vigil

#### Clone Repository

Clone the repository to your local machine:

```
git clone https://github.com/deadbits/vigil-llm.git
cd vigil-llm
```

#### Install YARA

Follow the instructions on the [YARA Getting Started documentation](https://yara.readthedocs.io/en/stable/gettingstarted.html) to download and install [YARA v4.3.2](https://github.com/VirusTotal/yara/releases).

#### Setup Python Virtual Environment

```
python3 -m venv venv
source venv/bin/activate
```

#### Install Vigil library

Inside your virtual environment, install Vigil library and required Python packages:

```
pip install -e .
```