Skip to content

index.mdx

Latest commit

 

History

History
150 lines (116 loc) · 7.57 KB

index.mdx

File metadata and controls

150 lines (116 loc) · 7.57 KB
Raw
title Introduction
description Welcome to the Osmedeus Documentation
icon hand-wave
og:title Osmedeus - Modern Orchestration Engine for Security

Introduction Banner

Osmedeus is a security focused declarative orchestration engine that simplifies complex workflow automation into auditable YAML definitions, complete with encrypted data handling, secure credential management, and sandboxed execution.

Built for both beginners and experts, it delivers powerful, composable automation without sacrificing the integrity and safety of your infrastructure.

Key Features

  • Declarative YAML Workflows - Define pipelines with hooks, decision routing, module exclusion, and conditional branching across multiple runners (host, Docker, SSH)
  • Distributed Execution - Redis-based master-worker pattern with queue system, webhook triggers, and file sync across workers
  • Rich Function Library - 80+ utility functions including nmap integration, tmux sessions, SSH execution, TypeScript/Python scripting, SARIF parsing, and CDN/WAF classification
  • Event-Driven Scheduling - Cron, file-watch, and event triggers with filtering, deduplication, and delayed task queues
  • Agentic LLM Steps - Tool-calling agent loops with sub-agent orchestration, memory management, and structured output
  • Cloud Infrastructure - Provision and run scans across DigitalOcean, AWS, GCP, Linode, and Azure with cost controls and automatic cleanup
  • Rich CLI Interface - Interactive database queries, bulk function evaluation, workflow linting, progress bars, and comprehensive usage examples
  • REST API & Web UI - Full API server with webhook triggers, database queries, and embedded dashboard for visualization

Hall of fame in light mode

Hall of fame in dark mode

Getting Started

CLI Run preview

Web UI Assets preview

Jump right in and run your first Osmedeus workflow in minutes.

Advanced Installation and Configuration

Detailed instructions for installing Osmedeus on various platforms. Configure the engine, runners, and environment variables. Deploy Osmedeus in a distributed environment or production setup. Resources for developers contributing to or extending Osmedeus.

Understanding Osmedeus

Core Concepts

Page Description
Architecture Layered architecture and data flow
Workflows Module vs Flow, execution lifecycle
Templates Variable interpolation and built-in variables
Runners Host, Docker, SSH execution environments
Functions JavaScript utility functions that bind to the core engine for use in workflow steps

Advanced Topics

Page Description
Distributed Execution Master-worker architecture
Scheduling Cron, event, and file-watch triggers
LLM Integration AI-powered workflow steps
Snapshots Workspace export and import

Workflows

Page Description
Overview YAML structure and workflow kinds
Step Types All 8 step types with examples
Flows Module orchestration and dependencies
Variables Parameters, exports, variable propagation
Control Flow Conditions, handlers, and decision routing

Extending Osmedeus

Page Description
Step Types Add custom step executors
Runners Implement new runner types
Functions Register utility functions
CLI Commands Add new CLI commands
API Endpoints Add new REST endpoints

Reference

Page Description
Workflow Schema Complete YAML schema
Variables Built-in variables
Types Go type definitions

Full Feature List

  • Declarative YAML Workflows - Define reconnaissance pipelines using simple, readable YAML syntax
  • Multiple Runners - Execute on local host, Docker containers, or remote machines via SSH
  • Event-Driven Triggers - Cron scheduling, file watching, and event-based workflow triggers with deduplication and filter functions
  • Template Engine - Powerful variable interpolation with built-in and custom variables
  • Utility Functions - Rich function library with event generation, bulk processing, and JSON operations
  • REST API Server - Manage, trigger, and cancel workflows programmatically
  • Distributed Execution - Scale with Redis-based master-worker pattern for parallel scanning (workers identified as wosm-<uuid8>)
  • Notifications - Telegram bot and webhook integrations
  • Cloud Storage - S3-compatible storage for artifact management
  • LLM Integration - AI-powered workflow steps with chat completions, embeddings, and agentic tool-calling loops
  • Agent Step Type - Agentic LLM execution with tool calling, sub-agents, and memory management
  • SAST Integration - SARIF parsing for Semgrep, Trivy, Kingfisher, Bearer with database import and markdown reporting
  • Language Detection - Auto-detect dominant programming language of source repositories (26+ languages)
  • Preset Installation - Reproducible deployments from curated preset repositories
  • Workflow Hooks - Pre/post scan steps via hooks field for setup and cleanup
  • Queue System - Delayed task execution with database and Redis polling, configurable concurrency
  • Nmap Integration - Port scanning with automatic XML/gnmap to JSONL conversion and database import
  • Tmux Sessions - Background process management via tmux (create, capture, send, kill sessions)
  • SSH & Sync - Remote execution and file synchronization across distributed workers
  • TypeScript Execution - Run inline TypeScript or TS files via Bun runtime
  • Webhook Triggers - Trigger workflow runs via unauthenticated webhook URLs
  • CDN/WAF Classification - Automatic asset classification from httpx data (CDN, cloud, WAF)
  • Module Exclusion - Exclude modules from flows by exact name or fuzzy substring matching
  • Cloud Infrastructure - Provision and manage cloud instances across multiple providers