Setup (30 seconds)
Configuration
Infrastructure
Workflow Mode
Custom Command Mode
Run arbitrary commands on cloud instances (mutually exclusive with-f/-m):
Template Variables
| Variable | Description |
|---|---|
{{Target}} | Target string or chunk file path (with -T) |
{{public_ip}} | Worker’s public IP |
{{private_ip}} | Worker’s private IP |
{{worker_name}} | Resource name |
{{worker_id}} | Cloud resource ID |
{{infra_id}} | Infrastructure ID |
{{provider}} | Provider name |
{{ssh_user}} | SSH username |
{{index}} | Worker index (0, 1, 2, …) |
Behavior
- Commands run in
/tmp/osm-custom/on the remote - Custom-cmds run sequentially per worker, in parallel across workers
- First failure stops remaining commands and skips post-cmds for that worker
- Sync downloads to:
<sync-dest>/<worker_name>-<ip>/<remote_path>
Flags Reference
| Flag | Short | Description |
|---|---|---|
--flow | -f | Flow workflow name |
--module | -m | Module workflow name |
--target | -t | Single target |
--target-file | -T | File containing targets |
--provider | -p | Cloud provider |
--instances | -n | Number of instances |
--timeout | Scan timeout (e.g., 2h, 30m) | |
--auto-destroy | Destroy infrastructure after completion | |
--reuse | Auto-discover existing infrastructure | |
--reuse-with | Reuse specific IPs (comma-separated) | |
--sync-back | Download workflow results (workflow mode) | |
--verbose-setup | Show full setup command output | |
--ansible | Use Ansible playbook for setup | |
--chunk-size | Targets per worker chunk | |
--chunk-count | Split targets into N chunks | |
--custom-cmd | Custom command (repeatable) | |
--custom-post-cmd | Post-command (repeatable) | |
--sync-path | Remote path to download (repeatable) | |
--sync-dest | Local sync directory (default: ./osm-sync-back) |
Cost Reference
| Provider | Instance | vCPU | RAM | Hourly |
|---|---|---|---|---|
| Hetzner | cx22 | 2 | 4 GB | ~$0.007 |
| Linode | g6-standard-2 | 2 | 4 GB | $0.018 |
| DigitalOcean | s-2vcpu-4gb | 2 | 4 GB | $0.02232 |
| AWS | t3.medium | 2 | 4 GB | $0.0416 |
| GCP | n1-standard-2 | 2 | 7.5 GB | $0.095 |
| Azure | Standard_B2s | 2 | 4 GB | $0.042 |
