Docs
How to set up ShipVitals, read it, connect your services and build on it.
Press / to search from anywhere on the page.
Start
- QuickstartGo from no account to your first real figure in four steps.
- ConceptsThe words ShipVitals uses, each in a few sentences, with the guide that covers it in full.
- Sign in to ShipVitalsYou sign in to ShipVitals with Google, with GitHub, or with a link sent to your email: there are no passwords.
- Connect a serviceConnections is where you connect the services your projects run on: Stripe, GitHub, Google Cloud, AWS, Vercel, OpenAI and the rest.
- Review bindingsWhen a connection finds things (Stripe products, GitHub repos, Firebase projects, domains), ShipVitals binds each to a project.
- ProjectsA project is one thing you run: an app, a website, a library.
- Join the private betaWhile ShipVitals is in private beta, new people get in with an invite code.
Dashboards
- Read the PortfolioThe Portfolio answers two questions: does anything need you, and how is the whole of what you run doing?
- Read a project's dashboardA project's page is the Portfolio for one project.
- Costs and budgetsThe Costs tab says what your projects cost, who is behind it and whether that fits your budgets.
- Revenue and profitThe Revenue tab says what you earn, what moved it, and what's left once costs are paid.
- Expiries and the calendarThe Obligations tab holds what has a date and no API to warn you: memberships, certificates, keys, renewals.
- How figures are computedWhere each figure in ShipVitals comes from, how fresh it is, and how to check it yourself.
Monitoring
- AlertsAlerts is where incidents are worked and where you choose what reaches you.
- The morning digestThe Good morning digest is one message a day that says what needs you.
- Check your connections' healthThe Connected tab of Connections answers one question: is your data current, and does anything need you?
- Browser checksA browser check opens one of your pages in a real browser in ShipVitals' cloud, on a schedule, and says whether what must be true was: the page loaded in time, a text is on it, nothing went wrong in its console or its own requests.
- Walk the guides in the cloudShipVitals' cloud can walk your project's how-to guides step by step in a real browser, as a careful reader would, against your staging site, and report what doesn't match.
- The release gateThe release gate answers one question about one commit: can this project ship?
- The status page and badgeA project can have two things the public can see: a status page that says whether it's up, and a badge with its verified MRR.
Checks on your machines
- Install the desktop appThe ShipVitals desktop app runs your projects' own checks (tests, a Docker smoke, a signing verification) on your computer and sends what they proved to your workspace.
- Sign in on the desktop app or vitalsThe ShipVitals desktop app and vitals sign in through your browser: the device shows a code, and you approve it on ShipVitals.
- Pair a runnerA runner is a machine paired to a workspace so it can run checks there: your laptop with the ShipVitals app, or a headless box with vitals.
- Run checksA check is one thing that can pass or fail on a machine: a test command, a Docker smoke, a signing verification.
- Walk the guidesThe desktop app and vitals walk can walk your project's how-to guides step by step in a browser on your machine, as a careful reader would, and report what doesn't match.
- What leaves your machineWhen the desktop app or vitals runs your checks, the results go to ShipVitals and most of the evidence stays on your machine.
Developers
- API referenceThe ShipVitals REST API: read-only endpoints for a workspace's projects, figures, costs, revenue, obligations and health, with a workspace API token.
- API tokensA workspace API token lets a script or an agent read your workspace's figures: projects, costs, revenue, renewals and health.
- Connect your agentClaude Code, Claude Desktop, Cursor and other agents can answer questions about your projects through ShipVitals' MCP server: "What expires this month?", "What broke since the last deploy?", "Which project lost money last month?".
- The vitals command linevitals runs your project's own checks (tests, a Docker smoke, a signing verification) on your machine, and says whether the project can ship.
- Send test results and your own metricsTwo kinds of data come from you rather than from a service: test results from your CI, which show in a project's health, and metrics your own servers push, such as active users.
Workspace and account
- Invite people to your workspaceOwners and admins invite people from People.
- Accept an invitationAn invitation comes by email from ShipVitals: "… invited you to … on ShipVitals".
- Turn on two-factor sign-inTwo-factor sign-in asks for a 6-digit code from an authenticator app (1Password, Google Authenticator, Authy) each time you sign in on a new device.
- Account settingsYour account settings are yours alone, in every workspace.
- Plans and billingEvery workspace has a plan: Free, Indie, Studio or Agency, paid monthly or yearly.
- Export your data, delete a workspace or delete your accountDownload what ShipVitals holds about you or about a workspace, delete a workspace, or delete your account.
- Feedback and supportHelp is one place for the guides, the keyboard shortcuts, what's new, sending feedback, contacting support and ShipVitals' own status.
Connect a service
- Forward invoices by emailSome services have no API ShipVitals can read: a VPS host, a domain registrar, a small SaaS.
- Connect Google CloudGoogle Cloud and Firebase costs come from your billing export in BigQuery.
Each of the other 39 services has its steps, its scopes and troubleshooting on its page in the directory. All integrations
- Connect Anthropic
- Connect App Store Connect
- Connect AWS
- Connect Cloudflare
- Connect crates.io
- Connect DigitalOcean
- Connect Docker Hub
- Connect Domains and certificates
- Connect ElevenLabs
- Connect Fathom
- Connect GitHub
- Connect Google Analytics 4
- Connect Google Play
- Connect Gumroad
- Connect Homebrew
- Connect Lemon Squeezy
- Connect MailerSend
- Connect Mailgun
- Connect Neon
- Connect Netlify
- Connect npm
- Connect OpenAI
- Connect OpenRouter
- Connect Paddle
- Connect Plausible
- Connect Polar
- Connect PostHog
- Connect Postmark
- Connect PyPI
- Connect Resend
- Connect RevenueCat
- Connect Search Console
- Connect SendGrid
- Connect Sentry
- Connect Stripe
- Connect Supabase
- Connect Umami
- Connect Upstash
- Connect Vercel