Skip to content
Guides

Quickstart

Go from no account to your first real figure in four steps. Each step is short and links to the full guide for it. During the private beta you need a place first: see Join the private beta.

Sign in

Go to /signin and press Continue with Google or Continue with GitHub, or type your address in Work or personal email and press Email me a sign-in link. The first time, Your workspace asks you to confirm the workspace's name, currency and time zone: press Continue. See Sign in to ShipVitals.

Connect one service

Open Connections in the sidebar, or press g then c. The first visit asks What do you want to see first? with four cards:

  • Revenue: Stripe, with Continue to Stripe.
  • Costs: Google Cloud and Firebase, with Set up Google Cloud.
  • Code health: GitHub, with Continue to GitHub.
  • A website: uptime, TLS and domain expiry, with Watch a website.

Choose one and press its button. Continue to Stripe and Continue to GitHub take you to the service: approve ShipVitals there and you come back to Connected, already saved. Set up Google Cloud walks you through three steps and ends with Check access, then Done (see Connect Google Cloud). Watch a website asks for a domain.

If you already have a key, paste it into Paste a key instead: ShipVitals recognises the service and opens its dialog with the key in place. Where the service offers a read-only key, a key that can do more is refused before anything is sent, such as a Stripe secret key. Press Test connection. Nothing is saved until you press Done on Test passed. See Connect a service and The test result.

Confirm what was found

When the connection finds resources (Stripe products, GitHub repos, domains), press Review bindings. Rows marked Exact need nothing; check the ones marked Probable or Suggested, and press a row's project to move it. Then press Confirm … bindings. A proposed project becomes a real project when you confirm, if your plan has room for it. See Review bindings and Projects.

Read the Portfolio

Choose Portfolio in the sidebar, or press g then p. The Overview starts with Needs you, then five cards: Net profit · 30 days, MRR, Costs · 30 days, Fleet health and Next expiry. A "—" means nothing is known yet, never 0. Press a card to see how its figure was made. See Read the Portfolio and Explain a figure.

Next

  • Invite someone: in People, press Invite people and choose a role. See Invite people to your workspace.
  • Alerts and the digest: sensible rules are on from the start. Choose your channels and your Good morning digest in Alerts → Delivery. See Alerts and The morning digest.
  • Connect your agent: make a read-only token in Settings → API and add ShipVitals' MCP server to Claude Code, Claude Desktop or Cursor. See Connect your agent.