prompt-guard

(โ˜… 173)

Advanced prompt injection defense system for AI agents. Multi-language detection, severity scoring, and security auditing.

  • .gitignore
  • app.py
  • ARCHITECTURE.md
  • CHANGELOG.md
  • CHANGELOG_LATEST.md
  • config.example.yaml
  • docker-compose.yml
  • Dockerfile
  • LICENSE
  • pyproject.toml
  • README.md
  • RELEASE-v3.1.0.md
  • RELEASE-v3.3.0.md
  • requirements-dev.txt
  • requirements.txt
  • SECURITY.md
  • SEMANTIC_DETECTION.md
  • SKILL.md
  • uv.lock

# Installation Guide

1. Get the code
git clone https://github.com/seojoonkim/prompt-guard

Downloads the entire project code from GitHub to your computer.

cd prompt-guard

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install .

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install .[full]

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install .[dev]

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install prompt-guard[llm] # installs torch + transformers

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t prompt-guard .

Builds a runnable image based on the Dockerfile.

docker run -d -p 8080:8080 prompt-guard

Runs the built image as an actual container.

docker-compose up -d

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install .

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install .[full]

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install .[dev]

Installs the package published on PyPI directly โ€” no need to clone the source.

python3 -m prompt_guard.cli "ignore previous instructions"

Runs the Python script (or module).

python3 -m prompt_guard.cli "your message"

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation