Getting started

1. Connect a repository

Connect a GitHub or GitLab repository with read access. Onboarding ends there — no configuration file is required. You can connect from the dashboard or the CLI:

# install the CLI
curl -fsSL https://shipsanely.com/install.sh | sh

# authenticate and connect
shipsanely login
shipsanely connect github.com/acme/storefront

2. Repository analysis

The agent walks the codebase to detect services, entry points, dependencies, runtime versions, ports, background workers and scheduled jobs. Review the result before the first deployment:

shipsanely plan
→ services: web (next.js, node 20), api (fastapi, python 3.12), worker (celery)
→ datastores: postgresql, redis
→ env: DATABASE_URL, REDIS_URL, STRIPE_KEY, …

If the plan misses something — an unusual entry point, a private package registry — add a short hint in SHIPSANELY.md at the repository root. It is optional and written in plain language.

3. Environment variables

Connection strings for managed PostgreSQL and Redis are injected automatically. Secrets your application needs (API keys, tokens) are set once and stored encrypted:

shipsanely env set STRIPE_KEY=sk_live_…

4. Deployments

Every push to the connected branch produces a release. A release is built, provisioned, verified and only then promoted. Manual deployments and rollbacks are available:

shipsanely deploy            # deploy the current commit
shipsanely releases          # list releases and their verification status
shipsanely rollback r-0416   # return to a verified release

5. PostgreSQL & Redis

Managed datastores are private and reachable only from your app servers. Use the CLI to open a tunnel for local access or to trigger a manual backup:

shipsanely db tunnel         # psql to your private database
shipsanely db backup         # on-demand snapshot
shipsanely redis cli

6. Monitoring & repair

The agent monitors endpoint health, error rates, latency and resource usage. Incidents, diagnoses and repair actions appear in the activity log:

shipsanely incidents
! 02:14 api  p95 4.8s  cause: pool exhausted  fix: pool↑, rolling restart  ✓ 02:16

7. CLI reference

• login, connect, plan, deploy, releases, rollback
• env set|list|unset
• db tunnel|backup, redis cli
• logs, incidents, status

Missing something? Tell us — early-access docs follow the questions we receive.