Prerequisites

An existing Next.js project with a package manager installed.

Initialize

npx @abhivarde/syncui@latest init

Creates components.json and installs base dependencies.

Wrap your app

App Router needs a client boundary.

Using Pages Router? See Manual. Any Sync UI component inside App Router also needs "use client".

Run dev

npm run dev

Open http://localhost:3000.

You're all set. Add any component, block, or chart with the CLI, or copy the code straight from Components, Blocks, and Charts.