Skip to content

Install Riposte from scratch

Beginner ⏱ 5 minutes

Install the package, run the initializer, and you are ready to sync.

Install the server package

Run Riposte straight from npm. From an empty directory or an existing project, install the server runtime:

npm install @riposte.co/server

That brings in the CLI, default config, and generated types you can import in your own code.

Using pnpm or yarn?

Swap npm install with pnpm add or yarn add—Riposte ships as a standard npm package.

Initialize Riposte

Answer a short wizard to scaffold config, env vars, and unlock the onboarding checklist:

npx riposte-init

The initializer creates a riposte directory, writes your .env, and prints the one command you need next: npx riposte-run. Re-run it anytime to accept new defaults.

Skip the prompts

Automating setup? Pass --yes to accept defaults without interaction.

Run or embed the server

With files on disk, you can either boot the standalone server or mount it inside your own app:

  • Standalone: npx riposte-run to start the admin portal and API locally.
  • Embedded:
  • import { createRiposteServer } from '@riposte.co/server'; const riposte = await createRiposteServer(); app.use('/riposte', riposte.router);

Pick whichever path matches your workflow—the initializer generated everything you need.

Check the admin

When you run npx riposte-run, the admin portal opens with a guided checklist: pick Google or Microsoft first, wire databases/queues, and (optionally) authorize a pilot account before pasting the generated API examples into your product. Admin portal screenshot

Additional resources