Skip to navigation
Import design system

Install the design system CLI

Install the CLI

Clone the SDK repository and build from source:

git clone https://github.com/contentful/experience-design-system-sdk-public.git
cd experience-design-system-sdk-public
pnpm install
pnpm build

Link the CLI globally so the experiences binary is available on your PATH:

cd packages/experience-design-system-cli
pnpm link --global

Prerequisites

Before running the CLI, ensure you have the following:

  • Node.js 24+
  • pnpm 10.27+
  • A coding agent CLI — One of the following, installed and authenticated:
  • A Contentful Management API (CMA) token — Generate one in the Contentful web app under Settings > API keys > Content management tokens.
  • A Contentful space with Experiences enabled

Run experiences setup to install a coding agent and configure your Contentful credentials automatically. See Set up your environment.

Set up your environment

Run the interactive setup wizard to install a coding agent and configure your Contentful credentials:

experiences setup

experiences setup wizard

The wizard walks you through the following steps:

  1. Node.js — Detects nvm or fnm and offers to install Node 24.
  2. pnpm — Installs via corepack or npm.
  3. Install and build — Runs pnpm install && pnpm build from the monorepo root.
  4. Coding agent — Detects claude, codex, or opencode on your PATH. If none are found, presents a menu to install one.
  5. Contentful credentials — Prompts for CMA token, space ID, and environment ID. Saves them to ~/.config/experiences/credentials.json so they pre-fill in future sessions.
  6. Optional extras — Configure EDS_EXTRACT_CONCURRENCY for parallel extraction and NO_COLOR preference.

To skip individual steps:

experiences setup --skip-build --skip-agent --skip-credentials --skip-optional

Verify your environment

To check your environment at any time, run:

experiences doctor

Next steps

Continue with these guides: