Getting Started

Use this section to get ship-ai running quickly and safely on your machine.

Read Tech Stack so required services and optional integrations are clear before running setup.

Use Setup for the script-driven flow (bun run setup) or manual 5-step flow.

Use Configuration to align required secrets, feature flags, and service toggles.

Use Troubleshooting for Docker, DB, auth secret, queue, and optional Telegram issues.

Quick Links

Runtime, app surfaces, infra services, and queue model.

Script-based and manual setup paths with health checks.

Environment variables, feature flags, and service availability toggles.

High-signal diagnosis and fixes for common local failures.