> 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/vigil.md).

# Vigil

<div align="left"><figure><img src="/files/vq2Imd86tg8ORjnIpsZs" alt=""><figcaption></figcaption></figure></div>

## Overview 🏕️

`Vigil` is a Python library and REST API for assessing Large Language Model prompts and responses against a set of scanners to detect prompt injections, jailbreaks, and other potential risks. This repository also provides the detection signatures and datasets needed to get started with self-hosting.

* **Repo**:[ https://github.com/deadbits/vigil-llm](https://github.com/deadbits/vigil-llm)

This application is currently in an **alpha** state and should be considered experimental.

Work is ongoing to expand detection mechanisms and features.

### Highlights ✨

* Analyze LLM prompts for common injections and risky inputs
* Use Vigil as a Python library or REST API
* Evaluate detections and pipelines with **Vigil-Eval** (coming soon)
* Scanners are modular and easily extensible
* Available scan modules
  * [x] [Vector database / text similarity](/overview/use-vigil/scanners/vector-database.md)
    * [Auto-update vector database with detected prompts](/overview/use-vigil/configuration/auto-updating-vector-database.md)
  * [x] [Heuristics via YARA](/overview/use-vigil/scanners/yara-heuristics.md)
  * [x] [Transformer model](/overview/use-vigil/scanners/transformer.md)
  * [x] [Prompt-response similarity](/overview/use-vigil/scanners/prompt-response-similarity.md)
  * [x] [Canary Tokens](/overview/use-vigil/scanners/canary-tokens.md)
  * [ ] Sentiment analysis
  * [ ] Relevance (via LLM)
* Supports [local embeddings](https://www.sbert.net/) and/or [OpenAI](https://platform.openai.com/)
* Signatures and embeddings for common attacks
* Custom detections via [YARA signatures](https://yara.readthedocs.io/en/stable/)
* [Streamlit web UI playground](https://vigil.deadbits.ai/overview/use-vigil/web-server/web-ui-playground)

## Quick Links

{% content-ref url="/pages/GGt99ahnes2jQA4hT6QO" %}
[Install Vigil](/overview/install-vigil.md)
{% endcontent-ref %}

{% content-ref url="/pages/i6A6yfigI9z1YJWhPFcC" %}
[Use Vigil](/overview/use-vigil.md)
{% endcontent-ref %}

{% content-ref url="/pages/0OzdFecHB4ytNckKwpKJ" %}
[Scanners](/overview/use-vigil/scanners.md)
{% endcontent-ref %}

***