---
title: "Install the deeep CLI"
sidebarTitle: "Installation"
description: "Install the deeep CLI binary on macOS, Windows, and Linux. Set up your system PATH, verify dependencies, and configure global terminal access."
keywords: "install deeep cli, design system cli install, terminal binary setup"
icon: "download"
---

The deeep CLI is the command-line client for deeepSpace. It authenticates your account, links a local Git repository to a deeepSpace project, and syncs your local components with the design system.

## Requirements

Before installing, make sure you have:

- **Git** (for version control and component synchronization)
- A **deeepSpace account**
- An accessible operating system keyring for authentication

The packaged installers bundle Python. Python 3.13 or newer is required when running or installing from source. Storybook building additionally requires the Node.js runtime, package manager, and dependencies expected by your project.

## Install

<Warning>
Installer availability checked on September 16, 2026: the Apple Silicon and Linux URLs responded successfully, but the Intel Mac and Windows URLs returned HTTP 403. If your platform download is unavailable, contact [support@deeepspace.com](mailto:support@deeepspace.com) for an accessible installer. The platform paths below match the CLI's release configuration.
</Warning>

<Tabs>
  <Tab title="macOS">
    For Apple Silicon Macs:

    ```bash
    curl -fsSL https://cloud.deeepspace.com/deeep-cli/macos/silicon/latest/install.zip -o install.zip
    unzip install.zip
    ./install/deeep_installer
    ```

    For Intel Macs, replace `macos/silicon` with `macos/intel` in the URL.
  </Tab>

  <Tab title="Linux">
    ```bash
    curl -fsSL https://cloud.deeepspace.com/deeep-cli/linux/latest/install.zip -o install.zip
    unzip install.zip
    ./install/deeep_installer
    ```
  </Tab>

  <Tab title="Windows">
    1. Download the installer archive:

       ```text
       https://cloud.deeepspace.com/deeep-cli/windows/latest/install.zip
       ```

    2. Extract the archive and run `deeepSetup.exe`.
    3. Follow the installation wizard.
  </Tab>
</Tabs>

After installation, open a new terminal and run:

```bash
deeep auth
```

## Verify the installation

Check that the CLI is available:

```bash
deeep --version
```

You should see the installed version, for example:

```bash
deeep CLI v1.0.0
```

<Tip>
**PATH not found?** If the `deeep` command is not found, close and reopen your terminal to refresh your PATH.
</Tip>

## Update the CLI

To update to the latest version:

```bash
deeep update
```

This checks the version reported by the API and downloads a platform-specific installer when a newer version is available. If updating fails, download the installer above and reinstall.

## Uninstall

The CLI does not provide an `uninstall` command. To remove it manually:

<Tabs>
  <Tab title="macOS / Linux">
    Run `deeep logout` first to clear stored credentials. Then delete the installed binary directory:

    ```bash
    rm -rf ~/.deeep/bin
    ```

    The installer adds `. "$HOME/.deeep/env"` to `~/.profile`, `~/.zprofile`, `~/.bashrc`, and `~/.zshrc`. Remove that line from each profile that contains it, then remove `~/.deeep/env`. Also remove any older direct PATH entry for `~/.deeep/bin`. Project configuration files are separate from the installed binary.
  </Tab>

  <Tab title="Windows">
    Run `deeep logout`, then use Windows Settings to uninstall **deeep CLI** from the installed apps list.
  </Tab>
</Tabs>

## Troubleshooting

- **Permission errors on macOS/Linux**: Make the installer executable with `chmod +x ./install/deeep_installer` before running it.
- **PATH issues on macOS/Linux**: Restart your terminal, or run `source "$HOME/.deeep/env"` in your current shell. Keep the complete installed bundle, including `_internal`; copying only the executable is insufficient.
- **Installation fails**: Contact [support@deeepspace.com](mailto:support@deeepspace.com) for help.

## Next steps

1. [Authenticate](/guides/authentication) with your deeepSpace account
2. [Connect your project](/guides/connect)
3. [Sync components](/guides/sync) with deeepSpace