Skip to content
Docs

Installation Guide

deeepCLI 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

Install

For Apple Silicon Macs:

Terminal window
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.

After installation, open a new terminal and run:

Terminal window
deeep auth

Verify the installation

Check that the CLI is available:

Terminal window
deeep --version

You should see the installed version, for example:

Terminal window
deeep CLI v1.0.0
✨ PATH not found?

If the deeep command is not found, close and reopen your terminal to refresh your PATH.

Update the CLI

To update to the latest version:

Terminal window
deeep update

This downloads and installs the latest release for your platform.

Uninstall

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

Delete the installed binary directory and remove ~/.deeep/bin from your PATH:

Terminal window
rm -rf ~/.deeep/bin

Then edit your shell profile (for example ~/.zshrc or ~/.bashrc) and remove the line that adds ~/.deeep/bin to PATH.

Troubleshooting

  • Permission errors on macOS/Linux: Make the installer executable with chmod +x ./install/deeep_installer before running it.
  • PATH issues: Restart your terminal after installation.
  • Installation fails: Contact support@deeepspace.com for help.

Next steps

  1. Authenticate with your deeepSpace account
  2. Connect your project
  3. Sync components with deeepSpace