getdesign CLI

0.6.11 verified Fri May 01 auth: no javascript

CLI tool for installing DESIGN.md templates into projects, supporting multiple brands. Current stable version 0.6.11. Releases are published on npm with patch version bumps. Key differentiator: opinionated templates for AI-friendly design documentation, focused on design systems. Requires Node >= 18. No alternative CLI tools exist for this specific DESIGN.md concept.

Common errors

error Error: Cannot find module '...' ↓

cause Missing package installation or corrupted node_modules.

fix

Run 'npm ci' or 'npm install' in the project using getdesign.

error Error: The engine 'node' is incompatible with this module. Expected version '>=18' ↓

cause Node version is below 18.

fix

Upgrade Node to version 18 or later.

Warnings

breaking The package requires Node >= 18. Older versions of Node will fail to run the CLI. ↓

fix Update Node to version 18 or later.

gotcha The 'add' command overwrites existing DESIGN.md without --force flag or prompt in some versions. ↓

fix Use --force flag to overwrite explicitly, or check target file doesn't exist first.

deprecated No known deprecations at this time.

Install

npm install getdesign

yarn add getdesign

pnpm add getdesign

Imports

default
wrong
```
npm install -g getdesign && getdesign add ibm
```
correct
```
npx getdesign add ibm
```
CLI is intended to be run via npx; global install is unnecessary.
add
```
npx getdesign add <brand>
```
The 'add' subcommand installs a template. Run from project root.
list
```
npx getdesign list
```
Lists available brands and descriptions.

Quickstart

Shows installing a template and listing available brands.

cd my-project
npx getdesign add ibm
npx getdesign list