Krkn-AI

Installation

Prerequisites

• Python 3.9+
• Podman or Docker Container Runtime
• krknctl
• uv package manager (recommended) or pip

Clone the Repository

To clone and use the latest krkn version follow the directions below. If you’re wanting to contribute back to Krkn-AI in anyway in the future we recommend forking the repository first before cloning.

$ git clone https://github.com/krkn-chaos/krkn-ai.git
$ cd krkn-ai 

Fork and Clone the Repository

Fork the repository

$ git clone https://github.com/<github_user_id>/krkn-ai.git
$ cd krkn-ai 

Set your cloned local to track the upstream repository:

cd krkn-ai
git remote add upstream https://github.com/krkn-chaos/krkn-ai

Disable pushing to upstream master:

git remote set-url --push upstream no_push
git remote -v

Install the dependencies

To be sure that Krkn-AI’s dependencies don’t interfere with other python dependencies you may have locally, we recommend creating a virtual enviornment before installing the dependencies. We have only tested up to python 3.9

Using pip package manager:

$ python3.9 -m venv .venv
$ source .venv/bin/activate
$ pip install -e .

# Check if installation is successful
$ krkn_ai --help

Using uv package manager:

$ pip install uv
$ uv venv --python 3.9
$ source .venv/bin/activate
$ uv pip install -e .

#  Check if installation is successful
$ uv run krkn_ai --help

Getting Started with Krkn-AI

To configure Krkn-AI testing scenarios, check out getting started doc.