@sentientui/cli
v0.2.6
Published
SentientUI CLI — `npx @sentientui/cli init` sets up adaptive UI in an existing React app (installs the SDK, writes env config, scaffolds an example, and prints the wrap instructions)
Downloads
932
Maintainers
Readme
@sentientui/cli
Sets up SentientUI adaptive UI in an existing React app.
npx @sentientui/cli initWhat init does
- Detects your framework (Next.js App/Pages Router, Vite, Remix, CRA) and package manager (pnpm, yarn, bun, npm).
- Installs
@sentientui/reactwith your package manager. - Writes
.env.localwith the right variable for your framework (NEXT_PUBLIC_SENTIENT_API_KEYorVITE_SENTIENT_API_KEY). Never clobbers: if the variable is already assigned — even empty — the file is left untouched. - Scaffolds
components/adaptive-example.tsx(orsrc/components/when your app usessrc/) — a working style-rung hero usinguseAdaptiveTokens. Skipped if the file already exists. - Prints the wrap instructions for your framework: the
<AdaptiveRoot>/ provider snippet to add to your layout, and what to do next.
What it does NOT do
init never edits your layout or any existing file. Nothing adapts until you do the wrap-and-mount step it prints — add the provider snippet to your root layout and mount the example component yourself.
Flags
| Flag | Description |
|------|-------------|
| --key pk_... | Your public API key, written into .env.local. Omit it to leave the value empty — the SDK then runs in keyless local mode (decisions simulated on-device, nothing sent), so you can build and style before creating an account. |
| --yes / -y | Accepted for npx muscle memory; init has no prompts, so this is already the default behavior. |
After init
Run your dev server and preview personas locally with ?sentient_persona=buyer (or researcher / deal_seeker / browser) — this override works in keyless local mode.
Full component and hook reference: the @sentientui/react README.
License
MIT
