Authentication connects your local development environment with deeepSpace, enabling you to link projects and sync components.
Before You BeginMake sure you have:

​
Getting Started

​
Logging In

The authentication process uses email verification to ensure secure access to your deeepSpace account. Here’s how to get started:
1

Start the authentication process

Run the auth command:
2

Enter your deeepSpace email

Enter the email address associated with your deeepSpace account.
3

Verify your email with the one-time code

Check your inbox for the verification code and enter it in the prompt:The CLI allows up to three verification attempts. On success, it confirms the authenticated email and suggests running deeep init.
The CLI stores your access token, refresh token, and email in the operating system keyring under the deeep service. They are not written into deeep.json. A working keyring backend is required. See Environment and local data for credentials and optional sign-in telemetry.

​
Account Management

​
Checking Authentication Status

You can verify your current authentication status at any time:

​
Logging Out

To log out and remove stored credentials:
Remember to log out when using shared or public computers to protect your account access.
To fully clean a machine you no longer use for deeepSpace development — removing both the stored credentials and a linked repository’s local files in one step — run deeep unlink --logout from inside that repository. Credentials can also be cleared alone with deeep logout.

​
Troubleshooting

Common authentication issues and solutions:

​
No verification code received

  • Check your spam or junk folder.
  • Request a new code by running deeep auth again.

​
Invalid code error

  • Make sure you’re using the most recent code sent to your email.

​
Session expired

  • The CLI attempts token refresh when the server reports an expired access token. If refresh fails or the session expires, run deeep auth again.

​
Too many attempts

  • Wait a few minutes before retrying. Restarting authentication does not bypass server rate limits.

​
Keyring unavailable

  • Make sure the operating system keyring is available and unlocked. Headless environments need a supported keyring backend; the CLI does not offer a token flag or noninteractive login.

​
Next Steps

Now that you’re authenticated, you can:
  1. Connect to your deeepSpace projects — see the Connect Project guide.
  2. Sync components between your codebase and deeepSpace.
  3. Access your team’s shared design system in Web Space.