Docs

Guides

Step-by-step recipes for the common ways to use Sypnia, from apps made with AI builders and Next.js on Vercel to Supabase, source maps in CI, alert e-mails from your own engine, and moving from Sentry.

Applies to EngineCloud At launch

View as Markdown

A guide takes one real situation from start to finish: what you will have at the end, numbered steps with the exact code, and what you should see after each one. The SDK pages are the reference; the guides are the routes through them.

Every guide says whether it applies to the open-source engine Engine, to Sypnia Cloud Cloud, or to both. The SDKs are the same for both, so most guides differ in one line: the address the SDK sends to.

Which guide for which situation

YouStart with
Built your app by describing it to an AI builderLovable, Bolt, v0 or Replit
Deploy a Next.js app on VercelNext.js on Vercel
Use Supabase as your backendSupabase apps
See checkout-3f9c.js:1:48211 in a stack instead of your own fileSource maps in CI
Run your own engine and want an e-mail when something breaksAlert e-mails from a self-hosted engine
Already use SentryComing from Sentry
Have not installed Sypnia yetA quickstart: Sypnia Cloud or self-host

Sections

Start hereWhat Sypnia is, how it works, what is open source and what is the paid cloud, and the two ways to get your first problem in plain words.ConceptsThe ten ideas Sypnia is made of, each defined precisely, from a project and its keys to problems, traces and alerts.SDKsHow your app sends data to Sypnia. One SDK for the browser, one for Node, one for Next.js, and the OpenTelemetry intake for every other backend.The agentHow Sypnia analyses a problem, what it writes, what it sends to a model and what it never does.MCP and skillsConnect your coding agent to Sypnia so it can ask what is failing in production, read what it needs to fix it, and set Sypnia up for you.API referenceThe Sypnia HTTP API: one API for the open-source engine and for Sypnia Cloud, with every endpoint, parameter, response and error.CLI referenceThe sypnia command: how to install it, the variables it reads, what its exit codes mean, and where each command is documented.Self-hostingWhat you run when you host the Sypnia engine yourself, what you need, what it costs, and what you do not get compared with Sypnia Cloud.How the engine is builtThe whole Sypnia engine on one page, from a click in your app to the sentence your coding agent reads, with the design rules and the code that holds them.Sypnia CloudHow the paid service works, from organizations and roles to plans, limits, billing, where your data lives, the GitHub App and support.Privacy and securityWhat Sypnia collects from your app and its users, what it never collects, how masking works, how to delete data, and how the service is protected.LicensingWhich licence covers each part of Sypnia, what you may do with it, how the name may be used, and the terms of a contribution.GuidesStep-by-step recipes for the common ways to use Sypnia, from apps made with AI builders and Next.js on Vercel to Supabase, source maps in CI, alert e-mails from your own engine, and moving from Sentry.ReferenceThe pages you look things up in, from the event schema and the glossary to what is planned, the changelog and the common questions.
↑↓ to move↵ to openEsc to close