Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.shipsec.ai/llms.txt

Use this file to discover all available pages before exploring further.

ShipSec Studio uses just as its command runner. Run just or just help to see all available commands.

​
Getting Started

​
Initialize Project

just init
Sets up the development environment:
  • Installs dependencies with Bun
  • Creates environment files from examples (backend/.env, worker/.env, frontend/.env)

​
Development Commands

​
Start Development Environment

just dev
Starts the full development environment with hot-reload:
  • Checks for environment files
  • Starts Docker infrastructure (Postgres, Temporal, MinIO, Loki)
  • Waits for services to be ready
  • Runs database migrations
  • Starts backend, worker, and frontend via PM2
Access points (all via nginx on port 80):
ServiceURL
Frontendhttp://localhost/
Backend APIhttp://localhost/api/
Analyticshttp://localhost/analytics/
Temporal UIhttp://localhost:8081

​
Stop Development

just dev stop
Stops all PM2 processes and Docker infrastructure.

​
View Logs

just dev logs
Streams logs from all application processes via PM2.

​
Check Status

just dev status
Shows status of PM2 processes and Docker containers.

​
Production Commands

​
Start Production

just prod
Starts the production environment using Docker Compose with pre-built images. Access points (all via nginx on port 80):
ServiceURL
Frontendhttp://localhost/
Backend APIhttp://localhost/api/
Analyticshttp://localhost/analytics/
Temporal UIhttp://localhost:8081

​
Build and Start

just prod build
Builds Docker images and starts the production environment.

​
Stop Production

just prod stop
Stops all production containers.

​
View Production Logs

just prod logs
Streams logs from all production containers.

​
Check Production Status

just prod status
Shows status of production containers.

​
Clean Production

This deletes all data.
just prod clean
Stops containers, removes volumes, and prunes Docker system.

​
Infrastructure Commands

​
Start Infrastructure

just infra up
Starts only the infrastructure containers:
  • PostgreSQL
  • Temporal
  • MinIO
  • Redis
  • Loki

​
Stop Infrastructure

just infra down
Stops all infrastructure containers.

​
View Infrastructure Logs

just infra logs
Streams logs from infrastructure containers.

​
Clean Infrastructure

just infra clean
Stops infrastructure and removes all volumes.
This deletes all data.

​
Utility Commands

​
Show All Status

just status
Comprehensive status check showing:
  • PM2 services
  • Infrastructure containers
  • Production containers

​
Reset Database

just db-reset
Drops and recreates the database, then runs migrations. This deletes all data.
This command requires PostgreSQL to be running (just dev or just infra up).

​
Build Images Only

just build
Builds production Docker images without starting containers.

​
Quick Reference

CommandDescription
just initInitialize environment
just devStart development
just dev stopStop development
just dev logsView dev logs
just dev statusCheck dev status
just prodStart production
just prod buildBuild and start production
just prod stopStop production
just prod logsView production logs
just prod cleanClean production data
just infra upStart infrastructure
just infra downStop infrastructure
just infra logsView infrastructure logs
just infra cleanClean infrastructure data
just statusShow all status
just db-resetReset database
just buildBuild images
just helpShow help

​
Environment Files

The just init command creates these environment files:
FilePurpose
backend/.envBackend API configuration
worker/.envWorker configuration
frontend/.envFrontend configuration
Each file is created from its corresponding .env.example template.