CLI Reference

CLI Reference

Installation

npm install -g @notjustcoders/ioc-arise
# or
pnpm add -g @notjustcoders/ioc-arise

Global Usage

npx @notjustcoders/ioc-arise [command] [options]
# or, if installed globally:
ioc-arise [command] [options]

Commands

generate

npx @notjustcoders/ioc-arise generate [options]
# or, if installed globally:
ioc-arise generate [options]

Options

Option	Short	Description	Default
--source <dir>	-s	Source directory to scan	src
--output <file>	-o	Output file path	container.gen.ts
--interface <pattern>	-i	Interface name pattern to match (regex)	I[A-Z].*
--exclude <patterns...>	-e	Exclude patterns for files	[]
--check-cycles		Only check for circular dependencies without generating	false
--verbose		Enable verbose logging	false

Examples

npx @notjustcoders/ioc-arise generate
npx @notjustcoders/ioc-arise generate --source ./src --output ./generated/container.ts
npx @notjustcoders/ioc-arise generate --interface "I[A-Z].*"
npx @notjustcoders/ioc-arise generate --exclude "**/*.test.ts" "**/*.spec.ts"
npx @notjustcoders/ioc-arise generate --check-cycles
npx @notjustcoders/ioc-arise generate --verbose
# or, if installed globally:
ioc-arise generate

analyze

ioc-arise analyze [options]

Options

Option	Short	Description	Default
--source <dir>	-s	Source directory to scan	src
--interface <pattern>	-i	Interface name pattern to match (regex)	I[A-Z].*
--exclude <patterns...>	-e	Exclude patterns for files	[]

Examples

ioc-arise analyze
ioc-arise analyze --source ./modules
ioc-arise analyze --interface ".*Service$"
ioc-arise analyze --exclude "**/*.test.ts"

visualize

ioc-arise visualize [options]

Options

Option	Short	Description	Default
--source <dir>	-s	Source directory to scan	src
--interface <pattern>	-i	Interface name pattern to match (regex)	I[A-Z].*
--exclude <patterns...>	-e	Exclude patterns for files	[]
--renderer <type>	-r	Renderer type (console)	console

Examples

ioc-arise visualize
ioc-arise visualize --renderer console
ioc-arise visualize --source ./modules

Configuration File

{
  "source": "src",
  "output": "container.gen.ts",
  "interface": "I[A-Z].*",
  "exclude": [
    "**/*.test.ts",
    "**/*.spec.ts"
  ],
  "checkCycles": false,
  "verbose": false,
  "modules": {
    "UserModule": ["user/**"],
    "TodoModule": ["todo/**"]
  }
}

Interface Patterns

Pattern	Matches
I[A-Z].*	IUserService, IRepository
.*Service$	UserService, EmailService
.*Repository$	UserRepository, TodoRepository

Exclusion Patterns

ioc-arise generate --exclude "**/*.test.ts" "**/*.spec.ts"
ioc-arise generate --exclude "**/tests/**" "**/mocks/**"
ioc-arise generate --exclude "**/*.d.ts" "**/*.js"

Package.json Scripts

{
  "scripts": {
    "ioc:generate": "ioc-arise generate",
    "ioc:analyze": "ioc-arise analyze",
    "ioc:check": "ioc-arise generate --check-cycles"
  }
}

Help

ioc-arise --help
ioc-arise generate --help
ioc-arise analyze --help
ioc-arise visualize --help