Skip to main content

​
Prerequisites

  • Docker Desktop (≥8 GB RAM)
  • Bun runtime
  • just command runner

​
Quick Setup

1

Clone and initialize

git clone https://github.com/shipsecai/studio.git
cd studio
just init
This automatically installs dependencies and creates environment files.
2

Start development environment

just dev
This starts all infrastructure (Postgres, Temporal, MinIO, Loki), runs migrations, and launches the full stack with hot-reload.
3

Open ShipSec Studio

Navigate to http://localhost and sign in or create an account.

​
Access Points

All services are accessible through nginx on port 80:
ServiceURL
Frontendhttp://localhost/
Backend APIhttp://localhost/api/
Temporal UIhttp://localhost:8081
Individual service ports are available for debugging (frontend: 5173, backend: 3211) but should not be used in normal development.

​
Your First Workflow

1

Create a new workflow

Click New Workflow in the dashboard. Name it “Subdomain Discovery”.
2

Add components

  • Drag Manual Trigger to the canvas
  • Drag Subfinder component to the canvas
  • Connect the trigger output to the Subfinder input
3

Run the workflow

Click Save, then Run. Watch the execution unfold in real-time with streaming logs and terminal output.

​
Common Commands

# View logs
just dev logs

# Check status
just dev status

# Stop everything
just dev stop

# Restart
just dev stop && just dev

​
Next Steps

Full Installation

Detailed setup and configuration options

Command Reference

All available just commands

Components

Explore available components

Architecture

Understand the system design