Skip to content

user cli commands

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

CLI Commands Reference

Siyarix v3.0.0 is a CLI-first security operations platform built on Typer. All functionality is accessible via the siyarix binary with subcommands and command groups.

Global Options

siyarix [OPTIONS] COMMAND [ARGS]...
Option Description
--config, -c Path to custom config file
--batch, -b Path to batch script file to execute
--mode, -m Execution mode: autonomous, integrated, registry
--target, -t Set initial target for the session
--session Resume a previous session by ID
--resume Resume the last existing session
--version Show version information
--help Show help message

Usage Modes

  1. Interactive REPL: siyarix (no subcommand) — launches the context-aware chat interface with 40+ slash commands
  2. Direct Command: siyarix scan 10.0.0.1 — executes and exits
  3. Pipe Mode: echo "scan 10.0.0.1" \| siyarix — batch commands via stdin
  4. Batch File: siyarix --batch script.txt — execute a script file
  5. Goal-Driven Agent: siyarix agent "enumerate services" — autonomous Observe-Reason-Act loop
  6. REST API Server: siyarix serve — start the HTTP/WebSocket API server

Core Commands

init

Interactive 12-step onboarding wizard — ethics pledge, requirements check, provider setup, and persona configuration:

siyarix init [--force] [--skip-requirements]

scan

Run security scans against one or more targets using discovered tools on PATH. Supports @targets.txt multi-target mode.

siyarix scan <targets...> [OPTIONS]
Option Description
--tool, -t Specific tool to use
--mode, -m Execution mode (autonomous, integrated, registry)
--output, -o Output format (table, json, yaml, csv, html, xml, raw, quiet)
--parallel, -p Number of parallel workers
--timeout Timeout per tool in seconds
--save, -s Save results to database
--dry-run Plan only, do not execute
--profile Use specific command profile
--cloud Run cloud provider scan (aws, azure, gcp, kubernetes, docker, all)

Scan subcommands for specialized workflows:

Subcommand Description
siyarix scan quick <target> Fast reconnaissance scan
siyarix scan full <target> Comprehensive scan with all tools
siyarix scan web <target> Web application security scan
siyarix scan network <target> Network infrastructure scan
siyarix scan cloud <provider> Cloud configuration scan
siyarix scan mobile <apk> Mobile APK analysis
siyarix scan iot <target> IoT device/firmware scan

discover

Asset and service discovery for specified targets:

siyarix discover <target>

run

Convert natural language into structured execution plans:

siyarix run "scan my network for open ports"
siyarix run "check SOC 2 compliance on the infrastructure"

agent

Goal-driven autonomous agent with Observe-Reason-Act loop:

siyarix agent "find all vulnerabilities on our web server"
Option Description
--mode Agent mode: registry (deterministic), autonomous (full AI), hybrid, interactive

health

Comprehensive system health check — model providers, tools, resources, and component status:

siyarix health

metrics

Session performance metrics — scan counts, durations, tool usage, cache hit rates:

siyarix metrics

ci-gate

CI/CD pipeline compliance gate — fails the build if security thresholds are not met:

siyarix ci-gate

report

Generate assessment reports from the KnowledgeGraph:

siyarix report generate [--format html|json|markdown|pdf] [--output file]

serve

Start the REST API + WebSocket server for programmatic access:

siyarix serve [--host 0.0.0.0] [--port 8000]

version

Display installed version and build information:

siyarix version

palette

Open interactive command palette (requires prompt_toolkit):

siyarix palette

render-cmd

Render a saved command profile with key=value substitution:

siyarix render-cmd <name> [key=value ...]

Sub-Command Groups

auth

API key management for AI providers. Supported providers: openai, gemini, anthropic, groq, together, openrouter, deepseek, xai, mistral, perplexity, cerebras, fireworks, zai, minimax, moonshot, nvidia, huggingface, azure.

siyarix auth set-key <provider>
siyarix auth list-keys
siyarix auth remove-key <provider>

profile

Command profile management for reusable command templates:

Command Description
siyarix profile list-cmds List saved command profiles
siyarix profile save-cmd <name> <command> Save a reusable command profile
siyarix profile rm-cmd <name> Remove a saved command profile

audit

Tamper-evident audit trail management using SHA-256 hash chaining:

Command Description
siyarix audit report View audit trail report
siyarix audit logs View detailed audit logs
siyarix audit verify Verify audit chain integrity

config

CLI configuration and settings management:

Command Description
siyarix config list Show all settings
siyarix config get <key> Get a single setting
siyarix config set <key> <value> Set a setting
siyarix config reset Reset to defaults
siyarix config edit Open config in default editor
siyarix config backup Backup current configuration
siyarix config restore Restore configuration from backup

completions

Generate and install shell completions:

siyarix completions [bash|zsh|fish|powershell]

theme

Terminal color theme customization. 12 built-in themes:

Command Description
siyarix theme list List available color themes
siyarix theme set <name> Set default color theme
siyarix theme preview [name] Preview a theme

Available themes: CYBER_NOIR, MATRIX, BLOODMOON, ARCTIC, GOLDENROD, ECLIPSE, SYNTHWAVE, DARK, LIGHT, NEON, MINIMAL, DEFAULT.

cache

Manage the LRU cache:

Command Description
siyarix cache status Show cache statistics
siyarix cache clear Clear all cached data

tool-registry

Manage and inspect discovered tools and providers:

Command Description
siyarix tool-registry list List all discovered tools on PATH (80+ parsers)
siyarix tool-registry providers List configured model providers with preference order
siyarix tool-registry update-metadata Refresh tool metadata cache

compliance

Run compliance assessments against security frameworks:

siyarix compliance run --framework soc-2
siyarix compliance run --framework all

playbook

Execute, list, and validate incident response playbooks:

Command Description
siyarix playbook run <name> Execute a saved playbook
siyarix playbook list List available playbooks
siyarix playbook validate <path> Validate a playbook file

Additional Commands

Command Description
siyarix session-log View structured session log
siyarix session branch Create or switch session branches

Output Formats

All commands support the --output / -o flag with these formats:

Format Description
TABLE Rich formatted table (default)
JSON Machine-readable JSON
YAML YAML structured output
CSV Comma-separated values
HTML HTML report
XML XML structured output
RAW Raw unformatted output
QUIET Minimal output

Exit Codes

Code Meaning
0 Success
1 General error / unknown command / target missing
2 Validation error
3 Permission denied / file missing
4 Timeout
5 Safety gate denied

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