ekairos-cli

1.22.3 verified Sat Apr 25 auth: no javascript

CLI tool for scaffolding and managing Ekairos components in projects. Current stable version is 1.22.3, released monthly. Focused on integration with Ink-based React CLIs and shadcn-style component management. Differentiates from generic CLIs by tightly coupling with the Ekairos design system and offering opinionated defaults for rapid UI development.

Common errors

error Error: Cannot find module 'ink' ↓

cause Missing peer dependency ink.

fix

Install ink: npm install ink

error Error [ERR_REQUIRE_ESM]: require() of ES Module ... from ... not supported. ↓

cause Using CJS require() for ESM-only package.

fix

Use import() or dynamic import; update to ESM.

error Command 'generate' not found. Did you mean 'add'? ↓

cause Deprecated command removed in recent version.

fix

Use 'add' subcommand instead.

Warnings

breaking Version 1.0 moved from CJS to ESM-only. Node <14 not supported. ↓

fix Update Node to >=14 or use dynamic import if CJS is required.

gotcha CLI uses Ink for rendering; must be run in an interactive terminal environment. ↓

fix Ensure environment supports TTY; avoid piping output without --no-color.

deprecated The 'generate' command is deprecated in favor of 'add' since v1.20. ↓

fix Use 'add' subcommand instead of 'generate'.

Install

npm install ekairos-cli

yarn add ekairos-cli

pnpm add ekairos-cli

Imports

ekairos
wrong
```
npm run ekairos
```
correct
```
npx ekairos-cli add button
```
CLI is intended to be run via npx; direct npm script usage may not resolve correctly.
programmatic API
wrong
```
const ekairos = require('ekairos-cli')
```
correct
```
import { cli } from 'ekairos-cli'
```
Package is ESM-only since v1.0; CJS require will fail. Use dynamic import if needed.
types
wrong
```
import { ComponentConfig } from 'ekairos-cli'
```
correct
```
import type { ComponentConfig } from 'ekairos-cli'
```
Type-only imports prevent bundling issues; ComponentConfig is a type, not runtime value.

Quickstart

Initialize a new project with Ekairos CLI, then add components 'button' and 'card' using the add subcommand.

npx ekairos-cli@latest init my-project
cd my-project
npx ekairos-cli add button
npx ekairos-cli add card