wehub-resource-sync
e30e75b5d4
Changesets / Create Version PR (push) Has been cancelled
Deploy Shadcn Registry / Deploy Production (push) Has been cancelled
Template Metrics / LOC + Bundle Size (push) Has been cancelled
Code Quality / Oxlint + Oxfmt (push) Has been cancelled
Code Quality / Template Sync (push) Has been cancelled
Code Quality / Build Changed Packages (push) Has been cancelled
Code Quality / Test Changed Packages (push) Has been cancelled
Deploy Expo Example / Deploy Production (push) Has been cancelled
Deploy Ink Example / Deploy Production (push) Has been cancelled
Python Tests / pytest (assistant-stream, 3.10) (push) Has been cancelled
Python Tests / pytest (assistant-stream, 3.12) (push) Has been cancelled
Python Tests / pytest (assistant-ui-sync-server-api, 3.10) (push) Has been cancelled
Python Tests / pytest (assistant-ui-sync-server-api, 3.12) (push) Has been cancelled
66 lines
2.3 KiB
Markdown
66 lines
2.3 KiB
Markdown
# `assistant-ui` CLI
|
|
|
|
[](https://www.npmjs.com/package/assistant-ui)
|
|
[](https://www.npmjs.com/package/assistant-ui)
|
|
[](https://github.com/assistant-ui/assistant-ui)
|
|
|
|
Command-line tool for adding shadcn-style components to your project, scaffolding a new app, and keeping your assistant-ui packages up to date.
|
|
|
|
## Installation
|
|
|
|
Run via your package manager of choice; nothing to install globally:
|
|
|
|
```bash
|
|
npx assistant-ui@latest <command>
|
|
pnpm dlx assistant-ui@latest <command>
|
|
yarn dlx assistant-ui@latest <command>
|
|
bunx assistant-ui@latest <command>
|
|
```
|
|
|
|
## Common tasks
|
|
|
|
```bash
|
|
# scaffold a new Next.js project
|
|
npx assistant-ui@latest create my-app
|
|
|
|
# scaffold a minimal project
|
|
npx assistant-ui@latest create my-app --template minimal
|
|
|
|
# scaffold from a feature example
|
|
npx assistant-ui@latest create my-app --example with-ai-sdk-v7
|
|
|
|
# scaffold an Expo / React Native project
|
|
npx assistant-ui@latest create my-app --native
|
|
|
|
# scaffold a React Ink terminal project
|
|
npx assistant-ui@latest create my-app --ink
|
|
|
|
# add assistant-ui to an existing project
|
|
npx assistant-ui@latest init
|
|
|
|
# initialize non-interactively for CI or agent flows
|
|
npx assistant-ui@latest init --yes
|
|
|
|
# add a component
|
|
npx assistant-ui@latest add thread
|
|
|
|
# update all @assistant-ui/* and assistant-* packages
|
|
npx assistant-ui@latest update
|
|
|
|
# run codemods after a major version bump
|
|
npx assistant-ui@latest upgrade
|
|
|
|
# print env + version info for a bug report
|
|
npx assistant-ui info
|
|
```
|
|
|
|
`init` falls back to `create` when no `package.json` is found, so a single command works for both new and existing projects. Use `init --yes` for CI and agent flows where prompts are not available.
|
|
|
|
## Templates
|
|
|
|
`create` scaffolds from named templates: `default` (AI SDK), `minimal`, `cloud`, `cloud-clerk`, `langchain`, `mcp`, `eve`. Pass `-t <name>`, pass `--example <name>` for examples such as `with-ai-sdk-v7`, use `--native` for Expo / React Native, use `--ink` for React Ink, or pass `--preset <url>` to scaffold from an `assistant-ui.com` playground link.
|
|
|
|
## Documentation
|
|
|
|
Full command reference, flags, and template details at [assistant-ui.com/docs/cli](https://www.assistant-ui.com/docs/cli).
|