Public DocsRoute-backed sectionsUpdated July 24, 2026

Clivly docs that match the product you ship today

Install the CLI, scaffold your routes, and connect your database to Clivly. Every step below is its own page, so you can deep-link straight to the one you need.

Start with QuickstartCLI Reference
What Changed In This Refresh
The previous page was accurate in parts, but it no longer mirrored the current integration path closely enough.

Lead with `clivly@next`, not the older stable line.

Added `create-clivly`, `connect()`, `doctor()`, and `cursorStore` guidance.

Separated framework recipes from widget and auth setup.

Kept better-auth, remote sync, and serverless guidance current.

CLIcli

CLI

Scaffold, pair, tunnel localhost, push schema, and use the current diagnostic ladder without leaving the docs route.

`init``status``doctor`
Core commands
The CLI does more than scaffold now, so it deserves its own route instead of a short appendix.
Package manager
terminal
npx clivly init
npx clivly login
npx clivly status
npx clivly dev
npx clivly push-schema
npx clivly add widget   # scaffold the chat-session route only
  • `init` scaffolds config, routes, and placeholders and can hand straight into login.
  • `dev` opens a tunnel so remote sync can hit localhost during development.
  • `push-schema` reports schema shape without a deployment.
  • `add widget` scaffolds only the chat-session route — idempotent, and it creates no widget record (that lives in the dashboard).
Use the right diagnostic command
The diagnostics ladder is part of the current experience and was underrepresented in the old route.
Package manager
terminal
npx clivly ping     # alias: credential + reachability stage only
npx clivly connect  # alias: connection stage only
npx clivly doctor   # full read-only diagnostics
npx clivly status   # the whole guided ladder
  • `ping` and `connect` are not separate checks — they run `status` scoped to a single stage.
  • `doctor` is the read-only deep check for config, sources, cursor/id columns, and heartbeat.
  • `status` is the guided ladder when the integration is not ready yet.
Previous
Quickstart
Open Section
Next
Keys & Environment
Open Section