deeep for the command overview. Run deeep --help or deeep <command> --help at any time for command-specific options.
Global options
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 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.
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.
See sync prerequisites and dry-run limits and Storybook hosting precedence. 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.
deeep whoami
Display the email address of the currently authenticated user and the CLI version.
deeep update
Check for updates and install the latest version of the deeep CLI.
deeep logout
Remove locally stored authentication tokens and sign out of deeepSpace.
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.
To permanently delete a project or disconnect its repository, use the deeepspace web app —
unlink only cleans the local codebase.
Common workflow
-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.