Skip to main content

Installation

Guide to installing and setting up the @easy/dev-kit package.

Package Installation​

pnpm add -D @easy/dev-kit

Using npm​

npm install --save-dev @easy/dev-kit

Using yarn​

yarn add -D @easy/dev-kit

Registry Configuration​

The package is hosted on the Easy.M private npm registry. Ensure your .npmrc is configured:

# .npmrc
@easy:registry=https://npm.eacore6.de/
//npm.eacore6.de/:_authToken=YOUR_NPM_TOKEN

Requirements​

Node.js​

  • Minimum Version: 18.0.0
  • The CLI uses ES modules and modern Node.js features

Peer Dependencies​

PackageVersionRequired
Vite>= 5.0.0Optional (for frontend development)

If you're developing a frontend app, Vite is required:

pnpm add -D vite

Package Exports​

The package provides multiple entry points:

// CLI (available as 'easy-dev' command after install)
import '@easy/dev-kit'

// Configuration helpers
import { defineDevKitConfig, loadConfig, findConfigFile } from '@easy/dev-kit/config'

// Vite plugin for CSS bundling
import { devCssBundle } from '@easy/dev-kit/vite-plugin'

Verify Installation​

After installation, verify the CLI is available:

# Check version
pnpm easy-dev --version

# Or with npx
npx easy-dev --version

# View available commands
pnpm easy-dev --help

Expected output:

Usage: easy-dev [options] [command]

Easy.M App Development Kit

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  start           Start development environment
  stop            Stop all managed processes
  status          Show status of services
  auth            Authenticate with Kratos
  install         Install an app via GraphQL
  uninstall       Uninstall an app via GraphQL
  help [command]  display help for command

Project Structure​

After setting up dev-kit, your project should have:

your-app/
├── devkit.config.ts          # Dev-kit configuration
├── package.json              # With @easy/dev-kit in devDependencies
├── web/
│   └── packages/
│       └── your-app/
│           ├── vite.config.ts  # With devCssBundle plugin
│           └── src/
└── cmd/                      # For Go apps
    └── app/
        └── main.go

Troubleshooting​

Command Not Found​

If easy-dev is not found, ensure:

  1. The package is installed in devDependencies
  2. Run via package manager: pnpm easy-dev or npx easy-dev

Registry Authentication Failed​

If you get 401 errors:

  1. Check your NPM_TOKEN is valid
  2. Verify .npmrc configuration
  3. Try re-authenticating with the registry

Peer Dependency Warnings​

If you see peer dependency warnings for Vite:

pnpm add -D vite@^5.0.0

Next Steps​