---
title: "Using the Tiptap CLI"
description: "A command-line interface to quickly install and configure Tiptap UI components. Learn how to get started in the docs!"
canonical_url: "https://tiptap.dev/docs/ui-components/getting-started/cli"
---

# Using the Tiptap CLI

A command-line interface to quickly install and configure Tiptap UI components. Learn how to get started in the docs!

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](https://github.com/ueberdosis/tiptap-ui-components).

## Usage

```bash
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 as editable source files.

Run in an empty directory, it scaffolds a new Vite or Next.js project; run in an existing project, it configures it. Either way, the components are copied into your `components/` folder — you then import and render them in your own page. They are not wired into a page for you, so a freshly scaffolded app still shows the framework's default starter page until you render a component. See the [Next.js](https://tiptap.dev/docs/ui-components/install/next.md) or [Vite](https://tiptap.dev/docs/ui-components/install/vite.md) guide for the full flow.

```bash
npx @tiptap/cli@latest init
```

#### Arguments

- components: the components to add

#### Options

```bash
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.

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

#### Example

```bash
npx @tiptap/cli@latest add button
```

#### Options

```bash
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.

```bash
npx @tiptap/cli@latest info
```

#### Options

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

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

### `login`

Log in to your Tiptap Cloud account to access paid components and templates.

```bash
npx @tiptap/cli@latest login
```

#### Options

```bash
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.

```bash
npx @tiptap/cli@latest logout
```

### `status`

Review your Tiptap Cloud authentication status and active plans.

```bash
npx @tiptap/cli@latest status
```

#### Options

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

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