Key Features
- 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
- Notifications - Telegram bot and webhook integrations
- Cloud Storage - S3-compatible storage for artifact management
- LLM Integration - AI-powered workflow steps with chat completions and embeddings
Getting Started
Quickstart
Jump right in and run your first Osmedeus workflow in minutes.
Advanced Installation and Configuration
Installation
Detailed instructions for installing Osmedeus on various platforms.
Configuration
Configure the engine, runners, and environment variables.
Deployment
Deploy Osmedeus in a distributed environment or production setup.
Development
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 7 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 |