CLI Commands

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

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.

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.

deeep init

Options:

Option	Description
`-f`, `--force`	Reinitialize an already linked project
`-c`, `--create`	Skip the prompt and create a new deeepSpace project from this repository

`deeep sync`

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

deeep sync

Options:

Option	Description
`--dry-run`	Build the component index without sending it to deeepSpace

`deeep status`

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

deeep status

`deeep whoami`

Display the email address of the currently authenticated user.

deeep whoami

`deeep update`

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

deeep update

`deeep logout`

Remove locally stored authentication tokens and sign out of deeepSpace.

deeep logout

Common workflow

# Authenticate
deeep auth

# Link or create a project
deeep init

# Sync components
deeep sync

# Check project status
deeep status

For more details about the configuration file, see the Project Settings Reference.