Installation - Akira Documentation
Description: LLM Security Testing Framework - Documentation

## Keyboard shortcuts

Press `←` or `→` to navigate between chapters

Press `S` or `/` to search in the book

Press `?` to show this help

Press `Esc` to hide this help

# Installation

## Requirements

- Python 3.11 or higher
- uv package manager (recommended)
- Rust toolchain (optional, for performance extensions)

## Quick Install

    # Clone the repository
    git clone https://github.com/yourusername/akira.git
    cd akira

    # Create virtual environment and install
    uv venv
    source .venv/bin/activate
    uv pip install -e .

## Development Install

For development with all optional dependencies:

    uv pip install -e ".[dev]"

This includes:

- `pytest` - Testing
- `ruff` - Linting
- `mypy` - Type checking

## Rust Extensions (Optional)

Akira includes optional Rust extensions for performance-critical operations like fuzzing and pattern matching. These are not required but improve performance significantly.

    # Install maturin
    uv pip install maturin

    # Build and install Rust extension
    cd rust
    maturin develop --release
    cd ..

To verify Rust extensions are available:

    python -c "import akira_core; print('Rust extensions loaded')"

## Verify Installation

    # Check version
    akira --version

    # List available modules
    akira list

You should see output like:

                                   Available Modules
    ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┓
    ┃ Name                      ┃ Category   ┃ Severity ┃ Description              ┃
    ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━┩
    │ dos/magic_string          │ dos        │ high     │ Tests for Claude magic   │
    │                           │            │          │ string DoS vulnerability │
    ...

## Troubleshooting

### `uv` not found

Install uv first:

    curl -LsSf https://astral.sh/uv/install.sh | sh

### Module import errors

Ensure you're in the virtual environment:

    source .venv/bin/activate

### Rust build fails

Make sure you have the Rust toolchain installed:

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh