Aegis

(β˜… 332)

Runtime policy enforcement for AI agents. Cryptographic audit trail, human-in-the-loop approvals, kill switch. Zero code changes.

  • .env.example
  • .gitignore
  • .nvmrc
  • .vercel-project-config.txt
  • .vercelignore
  • backup-production.sh
  • CHANGELOG.md
  • COMMERCIAL.md
  • CONTRIBUTING.md
  • docker-compose.dev.yml
  • docker-compose.yml
  • fly.toml
  • GETTING_STARTED.md
  • LAUNCH.md
  • LICENSE
  • Makefile
  • package-lock.json
  • package.json
  • PERFORMANCE.md
  • railway.json
  • README.md
  • render.yaml
  • ROADMAP.md
  • SECURITY.md
  • TRADEMARK.md
  • turbo.json
  • vercel.json

# Installation Guide

1. Get the code
git clone https://github.com/Justin0504/Aegis

Downloads the entire project code from GitHub to your computer.

cd Aegis

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
curl -fsSL https://aegistraces.com/install | sh

Downloads and runs the official install script in one line β€” this handles the full setup automatically.

curl -fsSL https://raw.githubusercontent.com/Justin0504/Aegis/main/scripts/install.sh | bash

Downloads and runs the official install script in one line β€” this handles the full setup automatically.

pip install agentguard-aegis

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 compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose up -d # production

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose -f docker-compose.dev.yml up # development (hot-reload)

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

docker compose -f docker-compose.dev.yml up # hot-reload enabled

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. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd packages/gateway-mcp && npm install && npm run build && node dist/server.js

Moves into the project folder you just downloaded.

cd apps/compliance-cockpit && npm install && npm run build && npm start

Moves into the project folder you just downloaded.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. 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 agentguard-aegis

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

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

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

Pulled directly from this repo's README.

6. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd packages/sdk-go

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

7. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd apps/desktop/proxy

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

8. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation