open-kritt

(β˜… 1,954)

Open-source, self-hosted AI vulnerability research tool that orchestrates agents to find and validate security issues in code.

  • .editorconfig
  • .env.example
  • .gitignore
  • .pre-commit-config.yaml
  • .prettierignore
  • .prettierrc.json
  • .release-please-manifest.json
  • AGENTS.md
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • CONTRIBUTION_TERMS.md
  • docker-compose.dev.yml
  • docker-compose.yml
  • kritt
  • kritt-headless
  • LICENSE
  • MAINTAINERS.md
  • OWNERSHIP.md
  • README.md
  • release-please-config.json
  • RELEASE.md
  • SECURITY.md
  • VERSION

# Installation Guide

1. Get the code
git clone https://github.com/Kritt-ai/open-kritt

Downloads the entire project code from GitHub to your computer.

cd open-kritt

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g mint

Installs the package published on the npm registry globally β€” 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 -f docker-compose.dev.yml up -d --build

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.

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.
npm install -g mint

Installs the package published on the npm registry globally β€” no need to clone the source.

npm run dev

Starts the development/run server.

βœ… 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 -r engine/requirements.txt

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

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

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