Installation

Requirements

• Node.js 20.18.2 or higher
• TypeScript 5.0 or higher (recommended)

Package Installation

Install cmd-ipc using your preferred package manager:

npm

npm install @coralstack/cmd-ipc valibot

yarn

yarn add @coralstack/cmd-ipc valibot

pnpm

pnpm add @coralstack/cmd-ipc valibot

bun

bun add @coralstack/cmd-ipc valibot

Note

Valibot is a peer dependency used for schema definition and validation. It’s a lightweight alternative to Zod with excellent tree-shaking support. Unlike Zod, Valibot doesn’t use eval or new Function(), making it compatible with strict Content Security Policy (CSP) environments and runtimes like Cloudflare Workers where these are restricted.

TypeScript Configuration

cmd-ipc uses decorators for the @Command syntax. Enable decorators in your tsconfig.json:

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

Caution

Both experimentalDecorators and emitDecoratorMetadata are required for the @Command decorator to work correctly.

Reflect Metadata

The decorator system requires reflect-metadata. Import it once at your application’s entry point:

// main.ts or index.ts
import 'reflect-metadata'

// Rest of your application
import { CommandRegistry } from '@coralstack/cmd-ipc'

CLI Installation (Optional)

cmd-ipc includes a CLI for generating schemas from remote services. It’s included in the main package:

# Generate TypeScript schema from a remote HTTP endpoint
npx cmd-ipc generate-schema --url http://localhost:8787 --output ./src/api-schema.ts

Or add it as a script in your package.json:

{
  "scripts": {
    "generate-schema": "cmd-ipc generate-schema --url http://localhost:8787 --output ./src/generated/api-schema.ts --prefix api"
  }
}

Package Exports

cmd-ipc provides multiple entry points:

// Main exports - CommandRegistry, Channels, Decorators
import {
  CommandRegistry,
  MessagePortChannel,
  HTTPChannel,
  Command,
  registerCommands,
} from '@coralstack/cmd-ipc'

// Testing utilities
import { TestLogger } from '@coralstack/cmd-ipc/testing'