Using the Tiptap CLI

The Tiptap CLI helps you scaffold editors, install UI components or primitives, and configure Tiptap faster. It removes much of the manual work so you can start building editor features faster.

It’s designed for Vite or Next.js projects. If you use another framework, you’ll need to integrate Tiptap manually from the open-source repository.

Usage

npx @tiptap/cli@latest [command] [options]

Commands

`init`

Initialize your project and install dependencies. This command sets up your project configuration and adds any specified components.

npx @tiptap/cli@latest init

Arguments

components: the components to add

Options

Usage: @tiptap/cli@latest init [options] [components...]

Options:
-f, --framework <framework>   The framework to use (next, vite)
-c, --cwd <cwd>               The working directory (defaults to current directory)
-s, --silent                  Mute output
--src-dir                     Use the src directory when creating a new project

`add`

Add a Tiptap UI component or template to your project.

npx @tiptap/cli@latest add [components...]

Example

npx @tiptap/cli@latest add button

Options

Usage: @tiptap/cli@latest add [options] [components...]

Arguments:
  components                    The components to add

Options:
  -o, --overwrite              Overwrite existing files
  -c, --cwd <cwd>              The working directory (defaults to current directory)
  -p, --path <path>            The path to add the component to
  -s, --silent                 Mute output

`info`

Get information about your project configuration and setup.

npx @tiptap/cli@latest info

Options

Usage: @tiptap/cli@latest info [options]

Options:
  -c, --cwd <cwd>              The working directory (defaults to current directory)

`login`

npx @tiptap/cli@latest login

Options

Usage: @tiptap/cli@latest login [options]

Options:
  -e, --email <email>          Your account email
  -p, --password <password>    Your account password
  --write-config               Write the auth token to your package manager config
  -c, --cwd <cwd>              The working directory (defaults to current directory)

`logout`

Log out from your Tiptap Cloud account.

npx @tiptap/cli@latest logout

`status`

Review your Tiptap Cloud authentication status and active plans.

npx @tiptap/cli@latest status

Options

Usage: @tiptap/cli@latest status [options]

Options:
  -c, --cwd <cwd>              The working directory (defaults to current directory)