Skip to content
Docs

Sync Components

After linking your repository to a deeepSpace project, use the deeep sync command to upload your local component index. This keeps your design system in deeepSpace in sync with the components in your codebase.

Before you begin

Make sure you have:

How sync works

deeep sync scans your repository for components using the discovery settings configured during deeep init, builds a component index, and sends it to deeepSpace.

Depending on your project setup, it uses one of two discovery methods:

  • deeep CLI discovery — scans component directories directly.
  • Storybook discovery — reads your Storybook stories and index.json.

Sync your components

From the root of your linked Git repository, run:

Terminal window
deeep sync

On success you will see a summary of discovered and synced components.

Dry run

To build the component index without sending anything to deeepSpace, use:

Terminal window
deeep sync --dry-run

This is useful for verifying that your discovery configuration picks up the expected components before syncing.

Requirements

deeep sync will fail if any of the following are missing:

  • You are inside a Git repository.
  • You are authenticated (deeep auth).
  • The repository has been initialized (deeep init).
  • The linked deeepSpace project is connected to a Git repository.
  • A discovery configuration exists (CLI or Storybook).

Daily workflow

  1. Add or update components in your codebase.
  2. Run deeep sync to push the updated component index to deeepSpace.
  3. Continue working in deeepSpace with the latest component metadata.

Troubleshooting

  • Authentication required: Run deeep auth.
  • No project linked: Run deeep init to link a project.
  • Git repository required: Make sure you run the command from inside the linked repository.
  • Discovery configuration missing: Run deeep init --force to reconfigure component discovery.

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