Skip to content

user interactive chat

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

💬 Interactive Chat (REPL)

Welcome to the beating heart of Siyarix!

While you can certainly run Siyarix commands one-by-one from your standard terminal, the true power of the platform unlocks when you enter the Interactive Chat Mode (also known as the REPL - Read-Eval-Print Loop).

Think of it as a dedicated, context-aware command center where you and your AI co-pilot work together to hunt down vulnerabilities.

🚀 Launching the Chat

Getting in is easy. Just type the main command with no arguments:

siyarix

Instantly, you will be dropped into a beautiful, prompt_toolkit-powered shell.

🗣️ Natural Language Execution

Once inside, you don't need to memorize obscure flags. You can literally just talk to Siyarix:

> 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?

The AI engine automatically intercepts your natural language, interprets your intent, builds an execution plan, and runs the necessary tools behind the scenes.

🪄 The Magic of SmartAutocomplete

We hate typing out long IP addresses and file paths just as much as you do. The REPL comes equipped with SmartAutocomplete:

  • Hit Tab to autocomplete commands, target IPs, and file paths.
  • Siyarix remembers your conversation history and provides context-aware suggestions.
  • Type / to instantly see a dropdown list of every available slash command.

🪟 Split-Pane Layout

Want to keep an eye on the logs while you chat? Siyarix supports a gorgeous vertical split-pane view.

Just type /split in the chat!

  • Left Pane: Your input area and conversation history.
  • Right Pane: Live output, raw logs, or status information.

Pro-Tip: You can change what the right pane shows! Try typing /split timeline, /split metrics, or /split attack_map.

🗃️ Session Management & Memory

Siyarix doesn't suffer from amnesia. Your entire session is seamlessly persisted to a local SQLite database (~/.siyarix/sessions.db).

This means Siyarix remembers:

  • The exact commands you ran and when you ran them.
  • Your entire multi-turn conversation with the AI.
  • The findings and results of previous scans (so it can use them as context for future commands!).

Want to pick up where you left off tomorrow? You can resume any session perfectly.

⌨️ Keyboard Shortcuts

Navigate the REPL like a pro with these hotkeys:

Shortcut What it does
Tab Triggers the Smart Auto-complete
Up / Down Navigate through your command history
Ctrl+C Cancels whatever tool is currently running
Ctrl+L Clears the screen to keep things tidy
Ctrl+D Exits the REPL cleanly

📜 The Slash Command Reference

If you want to bypass natural language and issue direct commands to the Siyarix engine, use slash commands. Siyarix boasts over 54+ slash commands for total control.

(Don't try to memorize these! Just type / in the REPL and hit Tab to see them all.)

Core Controls

Command Description
/help Show all slash commands (or /help <cmd> for details)
/exit Exit the session
/clear Clear the terminal screen
/new Start a brand new, clean conversation thread
/history Show your command history

AI & Persona Management

Command Description
/persona Switch the AI's mindset (e.g., to Red Team or Blue Team)
/model Switch the AI provider model on the fly
/provider See or switch your active AI provider
/agent Launch an autonomous agent to achieve a goal

Security Operations

Command Description
/scan Run a quick scan directly from the chat
/target Set or show the current default target IP/URL
/tools List all available security tools from the registry
/opsec Run operational security checks on your environment
/stealth Toggle OPSEC stealth mode on or off
/report Generate an assessment report of your current findings
/diff Compare the results of two different scans

Customization & State

Command Description
/theme Change the terminal color theme
/split Toggle the split-pane layout
/config View or change configuration settings
/key Set or rotate your encrypted API keys
/save Manually save the current session state
/load Load a previously saved session

⏭️ Next Steps

You are now a master of the CLI and the REPL.

Ready to put it all together? Check out the Security Workflows guide to see how Siyarix handles real-world penetration testing and incident response scenarios!

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