Skip to content

getting started installation

Jump to bottom
MD MUFTHAKHERUL ISLAM MIRAZ edited this page Jun 24, 2026 · 2 revisions

📦 Installation Guide

Welcome! We are thrilled you're ready to install Siyarix.

We have designed Siyarix to be as lightweight and universally compatible as possible. Whether you are running a high-powered security workstation, a cloud instance, or even a mobile device, we have got you covered.

🛠️ System Requirements

Before we begin, let's make sure your system is ready:

  • Python: Version 3.11 or later is required.
  • Memory (RAM): Minimum 512 MB, but we strongly recommend 4 GB+ if you plan on running intensive, multi-wave AI autonomous operations.
  • Storage: ~500 MB of free disk space is recommended to comfortably house the security tool dependencies Siyarix might download.
  • Operating Systems Supported:
    • Linux (Debian, Ubuntu, Kali, Arch, etc.)
    • macOS
    • Windows (PowerShell 5.1+)
    • Mobile: Android (via Termux), iOS (via iSH), and HarmonyOS.

🚀 The Fastest Way: PyPI (Recommended)

The easiest and most common way to install Siyarix is directly through Python's package manager, pip.

Open your terminal and run:

pip install siyarix

✨ Optional "Extras" Packages

By default, the command above installs the core engine. However, Siyarix is highly modular! You can install specific "extras" to pull in SDKs for your favorite AI providers or extra UI components.

Just append the extra in brackets like this: pip install "siyarix[extra_name]"

Extra Name What it installs for you
autonomous (Highly Recommended) Installs the official SDKs for OpenAI, Anthropic, and Google Gemini all at once for peak autonomous performance.
openai Just the OpenAI SDK.
anthropic Just the Anthropic (Claude) SDK.
gemini Just the Google Generative AI SDK.
cli / terminal Pulls in Typer, Rich, prompt_toolkit, and Textual for the ultimate terminal experience.
security Installs Bandit, Safety, and pip-audit for internal security checks.
windows Adds necessary Windows-specific dependencies like colorama and pywin32.
all (The Kitchen Sink) Installs absolutely every optional dependency available.
dev Installs everything you need to contribute code (pytest, ruff, mypy, pre-commit).

Example Installations:

# I want to use OpenAI, Gemini, and Claude seamlessly:
pip install "siyarix[openai,gemini,anthropic]"

# Give me everything you've got!
pip install "siyarix[all]"

📦 Package Managers

If you prefer using your operating system's native package manager, we support those too!

Note

Note for new GitHub Organization: Remember to use the updated siyarix/siyarix repository URLs if you are pulling directly from source!

macOS (Homebrew)

brew install --build-from-source packages/homebrew/siyarix.rb

Windows (Winget)

winget install Mufthakherul.Siyarix

Windows (Chocolatey)

choco install siyarix

Debian / Ubuntu / Kali Linux

sudo dpkg -i packages/deb/siyarix_1.0.0-1_all.deb

Docker

Perfect for ephemeral, isolated security environments.

docker pull siyarix:latest

# Run Siyarix directly through the container:
docker run -it siyarix:latest --help

💻 Building Directly From Source

Are you a developer or just prefer living on the bleeding edge? You can build Siyarix directly from our GitHub repository.

# 1. Clone the repository
git clone https://github.com/siyarix/siyarix.git

# 2. Enter the directory
cd siyarix

# 3. Create a fresh virtual environment
python -m venv .venv

# 4. Activate the virtual environment
# On Linux/macOS:
source .venv/bin/activate  
# On Windows:
.\.venv\Scripts\Activate.ps1  

# 5. Install in editable mode with all features
pip install -e ".[all,cli,siem]"

⚡ Automated Platform Install Scripts

If you want an absolutely hands-off setup, we provide one-liner install scripts that automatically detect your OS, set up a virtual environment, and install Siyarix for you.

# 🐧 Linux & 🍏 macOS
curl -fsSL https://siyarix.dev/install.sh | bash

# 🪟 Windows (Run this in PowerShell)
irm https://siyarix.dev/install.ps1 | iex

# 📱 Android (Run inside the Termux app)
bash install_android.sh

# 🍎 iOS (Run inside the iSH app)
bash install_ios.sh

# 🌐 HarmonyOS
bash install_harmonyos.sh

✅ Verifying Your Installation

Once the installation finishes, let's make sure everything is working perfectly. Run the following commands in your terminal:

# Check the installed version
siyarix --version

# View the comprehensive help menu
siyarix --help

If you see the help menu, congratulations! 🎉 Siyarix is successfully installed on your machine.

⏭️ Next Steps

Now that you have the platform installed, it's time to wire up its brain!

Head over to the Onboarding Wizard guide. Siyarix features an incredible 11-step interactive wizard that will guide you through setting up your AI provider API keys and checking your local security tools.

Note

👋 Welcome to Siyarix! This is a personal passion project built by a single developer. It's currently under active development and growing fast. Expect rough edges, but lots of love! ❤️

🗺️ Siyarix Documentation Map

Welcome to the Siyarix Documentation Map! This page serves as your master compass for navigating the extensive documentation we have built for the platform.

Whether you are a brand new user, a seasoned security operator, or a developer looking to contribute to the core engine, you can find exactly what you need here.

🧭 Quick Navigation

Not sure where to start? Pick the path that best describes you:

🌱 For New Users

Just getting started? We highly recommend following these guides in order:

  1. Installation Guide — Get Siyarix running on your machine.
  2. Onboarding Wizard — Let our interactive wizard help you set up your API keys and environment.
  3. Setup & Configuration — A deeper dive into customizing your setup.
  4. Your First Run — A gentle walkthrough of your very first Siyarix command.

🛡️ For Security Operators

Ready to put Siyarix to work? Dive into our operational guides:

💻 For Developers & Contributors

Looking under the hood or wanting to write some code? Start here:

📂 The Complete Documentation Tree

If you prefer to browse the raw structure, here is a complete layout of the docs/ folder:

docs/
├── 🚀 getting-started/       # Installation, onboarding, and configuration
│   ├── installation.md       # Multi-platform install (pip, brew, winget, docker)
│   ├── onboarding.md         # The interactive 11-step setup wizard
│   ├── setup.md              # Managing API keys, credentials, and settings
│   ├── first-run.md          # A walkthrough of your first session
│   ├── configuration.md      # A deep-dive into advanced settings
│   └── troubleshooting.md    # Common issues and how to fix them instantly
│
├── 📖 user/                  # Daily operations and workflows
│   ├── cli-commands.md       # Reference for 50+ CLI commands across 12 groups
│   ├── interactive-chat.md   # Mastering the AI REPL and 54+ slash commands
│   ├── security-workflows.md # Recon, vulnerability assessment, incident response
│   ├── cloud-scanning.md     # Multi-cloud security scanning (under development)
│   ├── compliance.md         # Framework mapping (SOC 2, NIST, GDPR, PCI-DSS)
│   ├── threat-intelligence.md# Integrations with OTX, NVD, and MITRE ATT&CK
│   ├── playbooks.md          # Building automated YAML-based IR playbooks
│   ├── workflow-files.md     # DAG workflow reference (programmatic API)
│   ├── reporting.md          # Multi-format report generation
│   ├── offline-registry.md   # Running without AI (Offline/Registry execution mode)
│   └── ai-workflows.md       # Advanced AI-driven autonomous operations
│
├── 💻 developer/             # Building, testing, and extending Siyarix
│   ├── codebase-overview.md  # Full module structure mapping
│   ├── contribution-guide.md # How to submit PRs and our coding standards
│   ├── module-architecture.md# Component design and responsibilities
│   ├── testing.md            # Writing tests (pytest), coverage, and CI/CD
│   └── building.md           # Packaging, distribution, and Docker builds
│
├── 🏗️ architecture/          # System design and core internals
│   ├── overview.md           # High-level data flow and layered orchestration
│   ├── ai-agent-pipeline.md  # The AgentCore reasoning and execution pipeline
│   ├── provider-abstraction.md# How we unify 26 different AI providers
│   ├── execution-engine.md   # Plan-based step orchestration
│   ├── memory-and-state.md   # Knowledge graph, session persistence, and learning
│   ├── security-model.md     # The Permission Gate, DLP, audit logging, and OPSEC
│   └── intent-routing.md     # Semantic intent classification and routing
│
├── 🧠 ai/                    # Deep dive into the AI provider & agent systems
│   ├── routing.md            # Managing 26 providers, failovers, and circuit breakers
│   ├── persona-system.md     # Overview of our 10 security personas
│   ├── agent-reasoning.md    # The Observe-Reason-Act loop and tool call repair
│   ├── tool-execution.md     # The tool registry, capability graph, and parsers
│   ├── ensemble.md           # Parallel LLM voting strategies
│   ├── multi-wave.md         # Iterative goal execution with context carry-over
│   ├── prompt-architecture.md# System prompt design and management
│   └── safety.md             # Our rigorous 8-layer hallucination mitigation system
│
├── 🛡️ security/              # Safety, ethics, and threat models
│   ├── reporting.md          # How to safely report vulnerabilities to us
│   ├── threat-model.md       # System threat model and our mitigations
│   ├── operational-security.md# TOR routing, stealth modes, and OPSEC controls
│   ├── ethical-policy.md     # Mandatory rules of engagement for all users
│   └── abuse-prevention.md   # How we prevent misuse of the AI engine
│
└── ⚖️ legal/                 # Licensing and governance
    ├── agpl-guide.md         # A plain-English overview of the AGPL-3.0-or-later license
    ├── why-agpl.md           # The philosophy behind our license choice
    ├── trademark-policy.md   # Branding and trademark guidelines
    ├── responsible-ai.md     # Our framework for ethical AI usage
    ├── disclaimer.md         # Important legal disclaimers
    └── plugin-exception.md   # The license exception for building custom plugins

📖 Key Terminology

As you read through the documentation, you might encounter some specific terms. Here is a quick cheat sheet:

Term What It Means
Provider The backend AI engine powering Siyarix (e.g., OpenAI, Anthropic, Ollama).
Tool A traditional security executable installed on your system (e.g., nmap, nuclei).
Plan A step-by-step sequence of tool commands intelligently generated by the AI.
Workflow A hardcoded, predefined execution path (usually defined in YAML/JSON) that doesn't require AI generation.
Persona A specialized behavioral profile given to the AI (e.g., instructing it to act specifically as a "Network Recon Specialist").
Knowledge Graph Siyarix's internal memory where it stores findings (like IP addresses, open ports) to contextually inform future steps.

Need help finding something specific? Feel free to use the search bar at the top of the documentation site, or open a discussion on our GitHub!

Clone this wiki locally