Skip to navigation

Command reference

The design system import CLI has one command, experiences import. This guide explains how to start it, and how to use the Settings menu to manage your coding agent and Contentful credentials. To run your first import, see Getting started.

experiences import

Starts the CLI. It needs an interactive terminal that is at least 164 columns wide.

experiences import

The CLI opens on a home screen with three options:

  • Import starts the import flow, which asks for everything it needs on its own screens, including your project path and token file. For a description of each step, see Import flow.
  • Settings is where you manage your coding agent and Contentful credentials. It is covered in the next section.
  • Help shows your CLI version and where your settings, debug logs, tokens.json, and components.json files are stored.

Next: The next section covers the Settings menu, where you choose your coding agent and save your Contentful details so the import screens are pre-filled.

Settings

Choose Settings on the CLI home screen to manage the coding agent and Contentful credentials that the import uses. The CLI saves them to ~/.contentful/experience-design-system-cli/config.json.

MenuWhat you can change
Configuration > ProjectYour Contentful space ID, environment ID, CMA token, and API host. You can also set a default component directory, a default token file, and the Root Project Directory, which is where the CLI writes its .contentful folder.
Configuration > AgentsThe default coding agent, with a status for each supported agent: Claude Code, OpenAI Codex, OpenCode, Cursor, and GitHub Copilot. Open an agent to set its command path and model, or to run a test.
Opt-in AnalyticsTurns on or off sharing which CLI commands you use and where imports succeed or fail. It never includes source code, file paths, credentials, or authored content.
Debug ModeTurns on debug logging and sets how many days the CLI keeps the logs.

Press Esc or q to go back from a Settings screen.

Next steps

  • Getting started — Install the CLI, configure it, and run your first import.
  • Import flow — Learn what each step of the import does.
  • FAQ — Find answers to common questions.