Installation

Installation Methods

Choose the installation method that best suits your needs:

1. Quick Install (pip) - Fastest way to get started (recommended for users)
2. Development Setup (git + Makefile) - For contributors and advanced users
3. Manual Setup - Full control over the installation
4. Container Setup - Isolated environment with Docker/Podman

Quick Install (pip)

The easiest way to install hatiyar is from PyPI using pip:

Installation

pip install hatiyar

Running hatiyar

After installation, you can run hatiyar using either:

# Using the console script (if available in your PATH)
hatiyar

# Or using the module entry point
python -m hatiyar

# To launch the interactive shell directly
hatiyar shell
# or
python -m hatiyar shell

Verify Installation

Check the installed version:

hatiyar --version
# or
python -m hatiyar --version

Development Setup

For contributors or users who want the latest development version:

Prerequisites

Before installing hatiyar, ensure you have the following:

• Python 3.9 or higher - Download Python
• git - Install git
• uv - Install uv
• build-essential (Linux only, for Makefile-based setup) - C compiler and build tools
  • Debian/Ubuntu: sudo apt install build-essential
  • Fedora/RHEL: sudo dnf install gcc make
  • Alpine: apk add build-base

Installation Steps

1. Clone the Repository

git clone https://github.com/ajutamangdev/hatiyar.git
cd hatiyar

2. Set Up the Project

Use the Makefile to set up the virtual environment and install dependencies:

make setup

This will:

• Create a virtual environment (.venv)
• Install all dependencies with uv sync
• Activate the environment

3. Verify Installation

Check the project setup:

make info

This displays:

• Python version (from virtual environment)
• Tool versions (uv, mypy, ruff)
• Project configuration

4. Launch hatiyar

After setup, use the Makefile to launch hatiyar:

make shell            # Launch interactive shell
make info             # Show project info

All commands automatically use the activated virtual environment.

Manual Setup (Without Makefile)

If you prefer not to use Makefile or need more control over the setup:

1. Clone the Repository

git clone https://github.com/ajutamangdev/hatiyar.git
cd hatiyar

2. Create and Activate Virtual Environment

Using uv to create a virtual environment:

uv venv
source .venv/bin/activate  # On Linux/macOS
# OR
.venv\Scripts\activate     # On Windows

3. Install Dependencies

uv sync

4. Verify Installation

python3 src/hatiyar/main.py --version

5. Run the Hatiyar

python3 src/hatiyar/main.py shell  # Interactive shell

Container Setup (Docker/Podman)

hatiyar can be containerized for consistent deployment across environments. Use either Docker or Podman.

Prerequisites

• Docker: Install Docker
• Podman: Install Podman

Building the Container Image

Using Docker

# Build the image
docker build -t hatiyar -f Containerfile .

# Verify the image was created
docker images | grep hatiyar

Using Podman

# Build the image
podman build -t hatiyar -f Containerfile .

# Verify the image was created
podman images | grep hatiyar

Running the Container

Interactive Shell with Docker

docker run -it --rm hatiyar shell

Interactive Shell with Podman

podman run -it --rm hatiyar shell

With AWS Credentials (Local Development)

Mount your AWS credentials into the container for cloud operations:

Docker:

docker run -it --rm \
  -v ~/.aws:/home/appuser/.aws:ro \
  -e AWS_PROFILE=your-profile \
  hatiyar shell

Podman:

podman run -it --rm \
  -v ~/.aws:/home/appuser/.aws:ro \
  -e AWS_PROFILE=your-profile \
  hatiyar shell

Replace your-profile with your AWS profile name.

Troubleshooting Container Issues

”typer is not installed” Error

This error occurs when running a stale container image. Rebuild it:

# Docker
docker build -t hatiyar -f Containerfile . --no-cache

# Podman
podman build -t hatiyar -f Containerfile . --no-cache

The --no-cache flag forces a fresh build without using cached layers.

Container Image Details

The Containerfile uses a multi-stage build for efficiency:

1. Builder Stage (python:3.11-alpine): Compiles dependencies with uv
2. Runtime Stage (python:3.11-slim): Runs the application with minimal footprint

Environment variables in the runtime:

• PYTHONUNBUFFERED=1: Real-time log output
• PYTHONDONTWRITEBYTECODE=1: No .pyc files in container
• Non-root appuser for security

Platform-Specific Notes

Linux

Install system dependencies:

# Debian/Ubuntu (with build tools for Makefile)
sudo apt update
sudo apt install python3 python3-pip git build-essential

# Fedora/RHEL (with build tools for Makefile)
sudo dnf install python3 python3-pip git gcc make

# Alpine (with build tools for Makefile)
apk add python3 git build-base

Then install uv:

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

macOS

Using Homebrew:

brew install python git

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

Windows

1. Install Python
2. Install git for Windows
3. Install uv via PowerShell:

powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

Troubleshooting

uv Not Found

Verify uv is installed:

uv --version

If not installed, follow the uv installation guide

Python Version Issues

Check Python version:

python3 --version
# Should show 3.9 or higher

Next Steps

• Quick Start - Run your first exploit
• Usage Guide - Learn all commands
• Configuration - Customize settings

Updating

To update to the latest version:

cd hatiyar
git pull origin main
make setup  # Update dependencies and activate environment

Uninstallation

# Remove directory
cd ..
rm -rf hatiyar