Skip to main content
Install binaries, workflows, and manage the environment.

​
Synopsis

osmedeus install <command> [flags]

​
Commands

CommandDescription
binaryInstall binary tools from registry
workflow <source>Install workflows from URL/file
base <source>Install base folder from URL/file
envAdd binaries to shell PATH
validateCheck environment health

​
install binary

Install security tools from the binary registry. 
osmedeus install binary [flags]

​
Help Output

$ osmedeus install binary -h

◆ Description
  Install binaries from registry (direct fetch or Nix).

▶ Usage
  osmedeus install binary [flags]

▶ Flags
  -n, --name <name>                  Binary name(s) to install (repeatable)
  --all                              Install all required binaries
  --check                            Check installation status only
  --install-optional                 Include optional binaries
  --nix-installation                 Install Nix package manager
  --nix-build-install                Install binaries via Nix
  --list-registry-direct-fetch       List direct-fetch binaries
  --list-registry-nix-build          List Nix-compatible binaries

​
Flags

FlagDescription
-n, --name <name>Binary name(s) to install (repeatable)
--allInstall all required binaries
--checkCheck installation status only
--install-optionalInclude optional binaries
--nix-installationInstall Nix package manager
--nix-build-installInstall binaries via Nix
--list-registry-direct-fetchList direct-fetch binaries
--list-registry-nix-buildList Nix-compatible binaries

​
Direct Fetch Mode

Downloads pre-built binaries: 
# Install specific binary
osmedeus install binary --name nuclei

# Install multiple binaries
osmedeus install binary --name nuclei --name httpx --name ffuf

# Install all required binaries
osmedeus install binary --all

# Install quietly (suppress nix/git/apt output)
osmedeus install binary --all -q

# Include optional binaries
osmedeus install binary --all --install-optional

# Check status without installing
osmedeus install binary --name nuclei --check
osmedeus install binary --all --check

# List available binaries
osmedeus install binary --list-registry-direct-fetch

​
Nix Mode

Uses Nix package manager for reproducible builds: 
# Install Nix package manager first
osmedeus install binary --nix-installation

# List Nix-compatible binaries
osmedeus install binary --list-registry-nix-build

# Install all via Nix
osmedeus install binary --nix-build-install

# Install quietly (suppress nix build output)
osmedeus install binary --nix-build-install -q

# Install specific binary via Nix
osmedeus install binary --name nuclei --nix-build-install

​
Output

$ osmedeus install binary --all --check
Binary Installation Status:

┌────────────┬──────────┬─────────────────────────────┐
│ Name       │ Status   │ Path                        │
├────────────┼──────────┼─────────────────────────────┤
│ nuclei     │ ✓        │ ~/osmedeus-base/binaries/   │
│ httpx      │ ✓        │ ~/osmedeus-base/binaries/   │
│ subfinder  │ ✗        │ -                           │
│ amass      │ ✗        │ -                           │
└────────────┴──────────┴─────────────────────────────┘

Missing: 2 binaries

​
install workflow

Install workflows from external sources. 
osmedeus install workflow <source> [flags]

​
Sources

  • Git repository URL
  • ZIP file URL
  • Local file path

​
Examples

# From Git repository
osmedeus install workflow https://github.com/example/osmedeus-workflows.git

# From ZIP URL
osmedeus install workflow https://example.com/workflows.zip

# From local file
osmedeus install workflow ~/downloads/custom-workflows.zip

​
install base

Install or replace the entire base folder. 
osmedeus install base <source> [flags]

​
Notes

  • Backs up existing database
  • Restores database after installation
  • Use for complete environment setup

​
Examples

# From URL
osmedeus install base https://example.com/osmedeus-base.zip

# From local file
osmedeus install base ~/downloads/osmedeus-base.zip

​
install env

Add binaries folder to shell PATH. 
osmedeus install env [flags]

​
Effects

Adds to shell config (.bashrc, .zshrc): 
export PATH="$HOME/osmedeus-base/binaries:$PATH"

​
Usage

# Add to PATH
osmedeus install env

# Reload shell
source ~/.bashrc  # or ~/.zshrc

​
install validate

Check environment health. 
osmedeus install validate [flags]
Aliases: val

​
Checks

  • Base folder exists
  • Required directories present
  • Database accessible
  • Binaries installed
  • Workflows available

​
Output

$ osmedeus install validate
Environment Validation:

✓ Base folder: ~/osmedeus-base
✓ Binaries folder: ~/osmedeus-base/binaries
✓ Workflows folder: ~/osmedeus-base/workflows
✓ Workspaces folder: ~/osmedeus-base/workspaces
✓ Database: ~/osmedeus-base/database-osm.sqlite
✓ Settings: ~/osmedeus-base/osm-settings.yaml

Binaries: 15/20 installed
Workflows: 12 available (8 modules, 4 flows)

Status: Ready (some binaries missing)

​
Binary Registry

​
Direct Fetch Binaries

$ osmedeus install binary --list-registry-direct-fetch

Direct Fetch Binaries:
┌────────────────┬──────────────────────────────────────────────────┐
│ Name           │ Description                                      │
├────────────────┼──────────────────────────────────────────────────┤
│ nuclei         │ Fast vulnerability scanner                       │
│ httpx          │ HTTP probe tool                                  │
│ subfinder      │ Subdomain enumeration                            │
│ amass          │ Attack surface mapping                           │
│ ffuf           │ Web fuzzer                                       │
│ ...            │ ...                                              │
└────────────────┴──────────────────────────────────────────────────┘

​
Nix Binaries

$ osmedeus install binary --list-registry-nix-build

Nix Package Binaries:
┌────────────────┬──────────────────────────────────────────────────┐
│ Name           │ Nix Package                                      │
├────────────────┼──────────────────────────────────────────────────┤
│ nuclei         │ nixpkgs#nuclei                                   │
│ httpx          │ nixpkgs#httpx                                    │
│ ...            │ ...                                              │
└────────────────┴──────────────────────────────────────────────────┘

​
Common Workflows

​
Initial Setup

# Install all binaries
osmedeus install binary --all

# Add to PATH
osmedeus install env
source ~/.bashrc

# Validate
osmedeus install validate

​
Update Binaries

# Check current status
osmedeus install binary --all --check

# Reinstall all
osmedeus install binary --all

​
Nix Setup

# Install Nix first
osmedeus install binary --nix-installation

# Then install binaries via Nix
osmedeus install binary --nix-build-install

​
API Equivalent

# Get registry info
curl http://localhost:8002/osm/api/registry-info \
  -H "Authorization: Bearer $TOKEN"

# Install binary
curl -X POST http://localhost:8002/osm/api/install \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type": "binary", "name": "nuclei"}'

​
See Also