Skip to content

user interactive chat

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

Interactive Chat (REPL) Mode

The Siyarix REPL is the primary interaction interface — a full-featured interactive shell with AI-assisted planning, 40+ slash commands, split-pane layout, and SmartAutocomplete via prompt_toolkit.

Launching

siyarix        # Opens the REPL directly (default when no subcommand given)

Slash Commands

All available slash commands in the REPL:

Command Description
/help Show all slash commands
/exit Exit the session
/clear Clear conversation history
/new Start a new conversation thread
/history Show command history
/tools List available tools from the registry
/platform Show platform information
/status Show session status
/session Session management details
/uptime Show session uptime
/env Show environment variables
/intents Show parsed intent history
/shells List available shell tools
/search Search through findings and history
/examples Show usage examples
/reset Reset session state
/key Set or rotate API keys
/theme Change terminal color theme
/mode Switch interaction mode (integrated/registry/autonomous)
/model Switch AI provider model
/provider Switch AI provider
/report Generate a session report
/split Toggle split-pane layout
/batch Execute batch commands
/opsec Operational security checks
/siem SIEM integration commands
/intel Threat intelligence operations
/performance Show performance metrics
/cache Cache management
/campaign Campaign management for red team ops
/kb Knowledge base queries
/ticket Ticket/issue management
/retest Re-run previous tests
/stealth Toggle stealth mode
/audit Audit trail commands
/queue View execution queue
/diff Diff between scan results
/log View session logs

Natural Language Input

Type any natural language command and the AI interprets it via TaskPlanner:

> scan 192.168.1.1
> find all open ports on example.com
> run a vulnerability scan against the web server
> what tools do I have available?

Split-Pane Layout

Toggle a vertical split-pane view with /split:

  • Left pane: Input area with conversation
  • Right pane: Live output, logs, or status information

SmartAutocomplete

The REPL includes SmartAutocomplete with:

  • Tab completion for commands, targets, and file paths
  • Context-aware suggestions based on conversation history
  • Slash command discovery (type / to see all commands)

Session Management

Sessions are persisted to SQLite (~/.siyarix/sessions.db):

  • Commands executed with timestamps
  • AI conversation history (multi-turn context)
  • Findings and results
  • Session duration and metadata

Session Branching

Create divergent session branches with /branch:

> /branch investigation-v2
> /branch list
> /branch switch investigation-v1

Each branch maintains independent conversation history and findings.

Credential Store

API keys and secrets are stored with AES-256-GCM encryption in the local credential store. Manage keys via /key or the auth CLI command group.

Pipe and Batch Mode

Commands can be piped via stdin:

echo "scan 10.0.0.1" | siyarix

Or loaded from a batch file:

siyarix --batch commands.txt

Keyboard Shortcuts

Shortcut Action
Tab Auto-complete
Up / Down Navigate command history
Ctrl+C Cancel current operation
Ctrl+L Clear screen
Ctrl+D Exit REPL

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