---
title: "CLI Command Reference"
sidebarTitle: "CLI Commands"
description: "Complete terminal command reference for the deeep CLI. Syntax, arguments, and flags for auth, init, sync, status, whoami, logout, and unlink commands."
keywords: "deeep cli commands, cli syntax flags options, terminal reference"
icon: "terminal"
---

This guide provides a reference for all commands in the deeep CLI.

Run bare `deeep` for the command overview. Run `deeep --help` or `deeep <command> --help` at any time for command-specific options.

## Global options

| Option | Description |
|--------|-------------|
| `-v`, `--version` | Show the CLI version |
| `-h`, `--help` | Show help information |

---

## Commands

### `deeep auth`

Authenticate with deeepSpace. The command prompts for your email and then asks for a one-time verification code sent to your inbox.

```bash
deeep auth
```

### `deeep init`

Initialize the current Git repository as a deeepSpace project. The command walks you through selecting a workspace, choosing or creating a project, and configuring component discovery.

```bash
deeep init
```

**Options:**

| Option | Description |
|--------|-------------|
| `-f`, `--force` | Reinitialize an already linked project |
| `-c`, `--create` | Choose project creation without the create/link selection prompt; workspace, project details, discovery, and confirmation remain interactive |

`init` records the chosen discovery method remotely and attempts the first component sync. It then offers to update detected stack settings. Index or sync failures can leave a saved, usable project configuration: fix the reported issue and run `deeep sync`. An initialized project requires `--force` to change its setup.

### `deeep sync`

Scan your local components and sync the component index with the linked deeepSpace project.

```bash
deeep sync
```

**Options:**

| Option | Description |
|--------|-------------|
| `--dry-run` | Write the local index without uploading, updating remote stack settings, or hosting Storybook |
| `--storybook-hosting` | Build and host Storybook after component sync, overriding a saved URL |
| `--no-storybook-hosting` | Skip hosting even if enabled in `deeep.json` |

See [sync prerequisites and dry-run limits](/guides/sync) and [Storybook hosting precedence](/guides/storybook). Pass only one hosting flag; if both are supplied, the last flag wins.

### `deeep status`

Show the current project status, including the linked project name, workspace, and project settings.

```bash
deeep status
```

### `deeep whoami`

Display the email address of the currently authenticated user and the CLI version.

```bash
deeep whoami
```

### `deeep update`

Check for updates and install the latest version of the deeep CLI.

```bash
deeep update
```

### `deeep logout`

Remove locally stored authentication tokens and sign out of deeepSpace.

```bash
deeep logout
```

### `deeep unlink`

Remove this repository's local deeepSpace link. The command deletes `deeep.json` and the generated component index (`.deeep.index.json`, or the configured `componentIndexJsonPath`). Nothing is deleted from deeepSpace — the project, its components, and the connected repository stay intact, and you can link the repository again at any time with `deeep init`.

```bash
deeep unlink
```

**Options:**

| Option | Description |
|--------|-------------|
| `-y`, `--yes` | Remove the link without asking for confirmation |
| `--logout` | Also clear the stored deeepSpace credentials from this machine |

To permanently delete a project or disconnect its repository, use the deeepspace web app — `unlink` only cleans the local codebase.

---

## Common workflow

```bash
# Authenticate
deeep auth

# Link or create a project
deeep init

# Sync components
deeep sync

# Check project status
deeep status
```

All subcommands accept `-h` / `--help`. The CLI intentionally has no `pull`, `push`, `link`, `ls`, or `uninstall` commands; `deeep unlink` is the supported way to detach a repository, and its `-y` / `--yes` flag is the only noninteractive confirmation skip.

For more details about the configuration file, see the [Project Settings Reference](/reference/project-settings).