oasm-cli

CLI tool for Open Attack Surface Management. Generates docker-compose.yml, .env, and config files for OASM deployment.

Install

# Via go install
go install github.com/oasm-platform/oasm-cli@latest

# Or clone and install
git clone https://github.com/oasm-platform/oasm-cli.git
cd oasm-cli
go install ./cmd/oasm

Usage

oasm init

Interactive TUI for setting up a new OASM project. Generates Docker Compose stack with selected services.

oasm init

What it creates:

• docker-compose.yml — service definitions for selected components
• .env — environment variables (secrets, ports, image tags)
• nginx.conf — reverse proxy config (when console is selected)

Step 1: Select services

The TUI shows all available services, selected by default.

Key	Action
↑ / ↓	Navigate services
Space	Toggle service on/off
E	Edit selected service config
Enter	Confirm selection, generate files
Q / Esc	Quit

Step 2: Edit config (optional)

Press E on any selected service to edit its configuration.

Key	Action
Tab / ↓	Next field
Shift+Tab / ↑	Previous field
Enter	Save and return to service list
Esc	Cancel, discard changes

Available services

Service	Description	Key config
postgres	PostgreSQL database (pgvector)	User, Password, Database, Port
redis	Redis cache	Password, Port
geoip-database	GeoIP proxy	Image, Port
rustfs	S3-compatible object storage	AccessKey, SecretKey, Port
core-api	OASM API server	ImageTag, Port, CloudAPIKey, EnableMigration
console	Web UI (nginx frontend)	HostPort
worker	Background task worker	WorkerAPIKey, MaxConcurrency, Replicas

Default ports

Service	Container Port	Host Port
postgres	5432	— (internal only)
redis	6379	— (internal only)
geoip-database	4360	— (internal only)
rustfs	9000	— (internal only)
core-api	6276	16276
console	80	6276
worker	—	— (internal only)

Start

After running oasm init:

docker compose up -d

License

GPL-3.0 — see LICENSE for details.