-
Notifications
You must be signed in to change notification settings - Fork 2
user security workflows
Siyarix is designed to handle the heavy lifting of your day-to-day security operations. From initial reconnaissance to incident response and compliance, here are the core workflows you can run right out of the box.
Before you can secure a network, you have to understand it. Siyarix offers multiple ways to map your environment.
# ⚡ Quick Scan: Find live hosts and check the top 100 ports
siyarix scan-quick 10.0.0.0/24
# 🔍 Full Scan: Scan all 65,535 ports and detect service versions
siyarix scan-full target.example.com
# 🕵️ Deep Scan: A 4-pass scan (discovery → fingerprint → vuln → enumeration)
siyarix scan-deep target.example.com
# 🗺️ Discovery: Basic asset and service mapping
siyarix discover example.com
# 🧠 AI-Powered Recon: Just ask!
siyarix run "enumerate all subdomains and live hosts for example.com"
# 📴 Offline Recon: Scan without relying on an AI provider
siyarix scan 10.0.0.0/24 --mode offlineOnce you know what's out there, find out where it's weak.
# 🗣️ Natural Language Scan
siyarix run "scan target.example.com for common vulnerabilities"
# 🌐 Web App Scan: Specialized multi-tool preset for web targets
siyarix scan-web https://target.com
# 🤖 Agent-Driven Assessment: Let the AI handle the complex logic
siyarix agent "find all vulnerabilities on the web server and categorize by severity"
# 💾 Deep Scan & Save: Run a deep scan and persist results
siyarix scan-deep 10.0.0.1 --saveWeb apps are often the weakest link. Siyarix chains together standard tools (like Nikto, Nuclei, WPScan, and WhatWeb) dynamically based on what it fingerprints.
# 🚨 OWASP Top 10 automated scan
siyarix run "scan web application at https://target.com for OWASP Top 10"
# 🛠️ Standard Web Preset
siyarix scan-web https://target.comWhen things go wrong, Siyarix helps you manage the chaos.
# 📊 View the high-level security dashboard
siyarix security dashboard
# 📋 List all currently active incidents
siyarix security incidents
# 🔎 Drill down into a specific incident
siyarix security incident INC-001
# 📝 Manually create a new incident ticket
siyarix security incident-create --title "SQLi on login" --description "Blind SQL injection detected" --category intrusion --severity high
# 📓 List your pre-defined incident response playbooks
siyarix security playbooks
# 🚀 Execute a playbook to contain a threat
siyarix playbook run response-playbook.yml(For authorized engagements only!) Siyarix can help manage multi-phase red team operations.
# 🗺️ Plan a complex campaign using natural language
siyarix run "plan campaign: recon -> scan -> enumerate -> exploit"
# Track your campaign's progress interactively via the /campaign command in the REPL!Proactively hunt for bad actors in your environment.
# 🎯 Execute a predefined hunt query
siyarix security hunt q_ps_exec
# 📜 View all available threat hunt queries
siyarix security queries
# 🔍 Filter queries by specific MITRE tactics
siyarix security queries --mitre-tactic execution
# 📊 See your overall MITRE ATT&CK coverage
siyarix security mitre-coveragePrepare for your audits automatically.
# 🏛️ Run SOC 2 compliance checks against a specific target
siyarix compliance run SOC2 10.0.0.1
# 📄 Generate a beautiful, HTML compliance report
siyarix report generate --format html --output compliance-report.htmlNote
Siyarix is building support for major frameworks including: SOC 2, ISO 27001, NIST 800-53, GDPR, HIPAA, and PCI-DSS.
Let the AI take the wheel. The agent decomposes objectives, assigns sub-tasks, executes them, and aggregates the final results.
# 🧠 Full autonomous multi-step objective
siyarix agent "enumerate all services, find vulnerabilities, generate a report"
# ⚠️ Force autonomous mode (No confirmation prompts!)
siyarix agent "scan network" --mode autonomousEvery single command run by Siyarix is logged using a cryptographic SHA-256 hash chain. This provides tamper-evident proof of your actions for compliance and review.
# 📜 View the audit logs
siyarix audit logs
# ✅ Cryptographically verify the integrity of the audit chain
siyarix audit verify
# 📄 Generate a compliance-specific audit report
siyarix audit report soc2 -o audit-report.mdNote
👋 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! ❤️
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.
Not sure where to start? Pick the path that best describes you:
Just getting started? We highly recommend following these guides in order:
- Installation Guide — Get Siyarix running on your machine.
- Onboarding Wizard — Let our interactive wizard help you set up your API keys and environment.
- Setup & Configuration — A deeper dive into customizing your setup.
- Your First Run — A gentle walkthrough of your very first Siyarix command.
Ready to put Siyarix to work? Dive into our operational guides:
- Interactive Chat (REPL) — Learn how to use the powerful interactive terminal.
- Security Workflows — Best practices for recon, vulnerability assessment, and incident response.
- Cloud & IaC Scanning — How to secure your cloud environments and infrastructure code.
- Compliance Frameworks — Map your scans to SOC 2, HIPAA, ISO 27001, and more.
Looking under the hood or wanting to write some code? Start here:
- Contribution Guide — Our workflow, standards, and how you can help!
- Codebase Overview — A comprehensive map of our 82+ source modules.
- Testing Standards — How we ensure reliability with pytest and CI/CD.
- Module Architecture — Component design and responsibilities.
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
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!