Getting started
Finding your way around
The sidebar and New project, how an app's page is laid out, the Needs you list, notifications, Simple and Technical detail, the getting-started checklist, and the other shortcuts in the dashboard.
The sidebar. All projects is at the top, with your projects under it (the arrow folds them away). + New project starts something new: put something online from a GitHub link, a folder or a starter, describe what you want and let CLI plan it, or set it up step by step. All projects itself shows the getting-started checklist and your projects.
Notifications. The bell shows what happened across your projects. Dismiss one with its ×, or Clear all.
Signals. An app's dot says Live, Deploying, Not answering (it was running but stopped responding), Asleep, Running in the background (a worker with no web address), Failed, Paused: out of credit or Not deployed.
Needs you. The Projects page opens with one list of everything waiting on you, across all your projects: a deploy that failed, a security fix to accept, credit running low, a promise slipping, a domain that isn't connected, a proposed change or bounty to review. Each has one button that takes you straight to it, and an item goes away by itself once it's sorted (a failed deploy clears when a later one goes live). The list stays hidden when nothing needs you.
Every project and app in a sentence. The top of a project says how it's doing ("All 3 apps are up. $4.10 this month, about $12 by month's end. Nothing needs you."). An app's page does the same.
An app's page has five tabs:
- Overview: how it's doing, what it cost this month, how fast it is for visitors, what needs you, the latest deploys, and the go-live checklist.
- Activity: every deploy, and What happened (the story of outages, fixes and changes).
- Investigate: logs, requests, speed and usage, the console, and (in Technical detail) debugging tools.
- Settings: grouped by what you're trying to do: Basics (source and size, variables, domains), Keep it running (scaling, sleep, cron jobs), Speed and promises, Keep it safe, and Delete. The search box at the top finds any setting, even by the words you'd use ("dns", "secrets", "night").
- Money: charging for your app, what each request costs you, and sharing what comes in.
Databases get Overview (with the connection details), Data, Backups, Investigate and Settings. Old links to tabs like Logs or Variables still open in the right place.
Simple or Technical. At the bottom of the sidebar (and on New project), Simple (the default) hides IDs, raw numbers and rarely used settings. Technical shows everything. Searching settings always finds hidden ones too.
In Simple, an app's page answers three questions, Is it working?, What does it cost? and What changed?, with the things people do most: Open it, Logs, Variables and Add a domain. It has two tabs, Overview and Settings; Logs opens Investigate and shows its tab while you're there. New project in Simple is one box (paste a GitHub link, pick a starter or describe it); Set it up step by step switches to Technical for naming the project, choosing a region and connecting an agent.
The getting-started checklist. Once you have a project, the Projects page shows a short list of things worth doing, and each one ticks itself when it's done:
- Put an app online.
- Add your own domain.
- Set a spending limit (a monthly budget).
- Get alerts where you work (Slack, Discord, Telegram, a webhook, or your phone).
- Invite a teammate (optional if you work alone).
- Connect your AI.
Press Hide this if you don't need it.
Light or dark. The dashboard follows your device's setting. To pin one, use Auto / Light / Dark at the bottom of the sidebar, or under Account settings, Appearance.
Search and commands. Press Ctrl K (⌘K on a Mac) to jump to any project or app, or run common actions without clicking through menus.
On your phone. Install the dashboard as an app (the button is in the sidebar) to get notifications for outages and approvals.
Ask CLI. The button in the corner answers questions about your project in plain words and can make changes after you confirm them.
The checklist
GET /v1/me/checklist
POST /v1/me/checklist/dismiss {"dismissed": true}{
"steps": [
{ "id": "app_live", "title": "Put an app online", "why": "…", "done": true, "href": "/projects/prj_…" },
{ "id": "domain", "title": "Add your own domain", "why": "…", "done": false, "href": "/projects/prj_…" }
],
"done": 3,
"total": 6,
"complete": false,
"dismissed": false
}Each step is worked out from the person's projects when asked: a deploy that went live; a domain on any app; a monthly budget set (PUT /v1/projects/:id/budget); a notification channel or a push subscription; another person (not a key) on a project; an active API key or a connected app (OAuth grant). Dismissing is per person; send {"dismissed": false} to show it again. API keys can't call these.
Needs you and overviews
GET /v1/me/needs-you
GET /v1/projects/:id/overview
GET /v1/services/:id/overviewneeds-you returns up to 50 items, worst first, across every project the caller can see. Each has kind (on_hold, out_of_credit, low_credit, deploy_failed, dependency_fix, change_waiting, bounty_attempt, promise, domain_pending), level (stop or wait), the project and app, a title and detail in plain words, and action: {label, href} (a dashboard path). Low credit means under three days at the current pace; a domain counts after 15 minutes still pending.
A project overview returns sentence, apps: {total, up, down}, cost: {spentMicro, forecastMicro, balanceMicro} (this month so far, and at the current pace by month's end) and that project's needsYou. An app overview returns sentence, lastDeploy, liveSince, costThisMonthMicro, visitors: {fastPercent, visits} (from real visitor speed, share of today's visits with LCP ≤ 2.5 s) and its needsYou.
App page links
/services/:id?tab= takes overview (default), activity, investigate, settings, money, and for databases data and backups. view= picks the sub-view (deploys, story; logs, requests, usage, console, debug), and find= opens Settings searched for that text. The old names (deploys, story, variables, logs, requests, metrics, debug, console, payments, golive, connect) still work.
Simple and Technical
Stored in the browser (localStorage key cli:detail), applied as data-detail on <html>. In Simple, anything marked technical is hidden, and settings marked advanced are left out unless searched for.
Light mode
The theme is stored in the browser only (localStorage key cli:theme: light or dark; missing means follow the system). It sets data-theme on <html>, and the stylesheet defines light tokens for both the pinned choice and prefers-color-scheme: light.
Notifications
GET /v1/me/inbox
POST /v1/me/inbox/dismiss {"seq": 42}
POST /v1/me/inbox/clear {"upTo": 57}Dismissing and clearing are per person; new events still arrive.
Search, commands and home
- Command palette: Ctrl K / ⌘K, or the search box at the top of the sidebar.
- Since you last looked (for agents and scripts):
GET /v1/home?since=andPOST /v1/home/seen(see /docs/monitoring). - Ask CLI:
POST /v1/projects/:id/assistant; proposed changes run only afterPOST /v1/projects/:id/assistant/confirm.