-
Notifications
You must be signed in to change notification settings - Fork 10
Usage
Medusa runs in two modes: an interactive TUI menu (default) and a non-interactive CLI for scripting and automation.
./medusa.shAt startup you select or create an environment (see Environments). Then the main menu offers:
| Key | Action |
|---|---|
1 |
SOC / Detection & Response (14 tools) |
2 |
GRC / Governance & Compliance (5 tools) |
3 |
Integration, IAM / Cloud / CI/CD (11 tools) |
4 |
OT / Industrial Security (5 tools) |
5 |
Status Dashboard |
6 |
Start all deployed tools |
7 |
Stop all tools |
C |
System configuration |
Q |
Quit |
Inside a module, each tool shows a live status (running, stopped, installed, ---). Selecting a tool opens a per-tool action menu whose options depend on its type and state:
- Docker tool: Start, Stop, Restart, Detailed status, Logs, Reinstall, Remove.
- CLI tool: Launch (guided sub-menu), Reinstall, Remove.
- Not installed: Install / Deploy.
Press B (or 0) to go back at any level.
./medusa.sh <command> [arguments]| Command | Description |
|---|---|
menu |
Interactive menu (default when no command given) |
deploy <tool> |
Deploy / install a tool |
start <tool|all> |
Start a tool, or every deployed tool |
stop <tool|all> |
Stop a tool, or every tool |
restart <tool> |
Restart a Docker tool |
status [tool] |
Status dashboard, or one tool's container status |
logs <tool> [lines] |
Follow logs (default 100 lines) |
remove <tool> |
Remove a tool and all its data (asks for confirmation) |
list [category] |
List tools, optionally filtered by soc, grc, integration, ot
|
check |
Check prerequisites |
version |
Print version |
help |
Show usage |
install is an alias of deploy; uninstall of remove; ls of list.
./medusa.sh deploy wazuh
./medusa.sh start opencti
./medusa.sh logs misp 200
./medusa.sh status
./medusa.sh list soc
./medusa.sh remove gophishIn CLI mode there is no interactive environment prompt. Set ENV_NAME to target a named deployment tree (defaults to default):
ENV_NAME=audit_client ./medusa.sh deploy keycloak
ENV_NAME=audit_client ./medusa.sh statusSee Environments for details.
Next: Tools-SOC · Ports-Reference · Environments
Repository · Issues · Security policy · MIT License
Get running
Concepts
Tool catalog
Reference
Develop