assistant-ui CLI

The assistant-ui CLI for adding components and dependencies to your project.

Usage

Use the init command to initialize dependencies for a new or existing project.

The init command installs dependencies, adds components, and configures your project for assistant-ui.

npx assistant-ui@latest init

create

Use the create command to scaffold a new Next.js project with assistant-ui.

The create command uses create-next-app with assistant-ui starter templates.

npx assistant-ui@latest create my-app

You can choose from multiple templates:

# Default template with Vercel AI SDK
npx assistant-ui@latest create my-app

# With Assistant Cloud for persistence
npx assistant-ui@latest create my-app -t cloud

# With LangGraph integration
npx assistant-ui@latest create my-app -t langgraph

# With MCP support
npx assistant-ui@latest create my-app -t mcp

add

Use the add command to add components to your project.

The add command adds a component to your project and installs all required dependencies.

npx assistant-ui@latest add [component]

Example

npx assistant-ui@latest add thread

You can also add multiple components at once:

npx assistant-ui@latest add thread thread-list assistant-modal

update

Use the update command to update all assistant-ui packages to their latest versions.

npx assistant-ui@latest update

upgrade

Use the upgrade command to automatically migrate your codebase when upgrading to a new major version.

The upgrade command runs codemods to transform your code and prompts to install new dependencies.

npx assistant-ui@latest upgrade

Documentation

Visit https://assistant-ui.com/docs/cli to view the full documentation.

License

Licensed under the MIT license.