CLI Reference

CLI ToolCode GenerationAnalysis

CLI Reference

🚀 Quick Start

Most projects just need: npx @notjustcoders/ioc-arise

The CLI automatically detects your project structure and generates everything!

Installation

NPX (Recommended)

# No installation needed! Run directly:
npx @notjustcoders/ioc-arise

✅ Always uses latest version
✅ No global installation
✅ Perfect for CI/CD

Local (Dev Dependency)

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

Then add to package.json:

{
  "scripts": {
    "generate:di": "ioc-arise"
  }
}

Global

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

Then use anywhere:

ioc-arise

Commands

generate (Default)

✨ Main Command

Analyzes your TypeScript code and generates a complete DI container with type declarations.

npx @notjustcoders/ioc-arise [options]
# "generate" is the default command, so you can omit it!

Options Reference

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 (regex)	I[A-Z].*
--exclude <patterns...>	-e	Exclude patterns for files	[]
--check-cycles		Check circular deps only (no generation)	false
--verbose		Enable verbose logging	false

Common Examples

Basic Usage

# Simplest form - uses defaults
npx @notjustcoders/ioc-arise

# With custom source directory
npx @notjustcoders/ioc-arise --source ./app

Custom Output

# Custom output location
npx @notjustcoders/ioc-arise \
  --source ./src \
  --output ./generated/di-container.ts

Filtering

# Exclude test files
npx @notjustcoders/ioc-arise \
  --exclude "**/*.test.ts" "**/*.spec.ts" "**/mocks/**"

# Custom interface pattern
npx @notjustcoders/ioc-arise \
  --interface ".*Service$"

Validation Only

# Check for circular dependencies without generating
npx @notjustcoders/ioc-arise --check-cycles

# Perfect for CI/CD pipelines!

analyze

🔍 Understand Your Architecture

Lists all discovered classes, their dependencies, and detects circular dependencies without generating code.

npx @notjustcoders/ioc-arise analyze [options]

Options

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

Example Output

$ npx @notjustcoders/ioc-arise analyze

📋 Found 15 classes:

📦 UserService
   File: /src/user/UserService.ts
   Implements: IUserService
   Dependencies: IUserRepository, ILogger

📦 UserRepository
   File: /src/user/UserRepository.ts
   Implements: IUserRepository
   Dependencies: none

✅ No circular dependencies detected!

Use Cases:

• 📊 Review dependency graph
• 🔍 Debug dependency issues
• 📝 Generate documentation
• ✅ Validate architecture

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

Create an ioc.config.json file in your project root:

{
  "sourceDir": "./src",
  "outputPath": "./src/container.gen.ts",
  "interface": "I*.ts",
  "exclude": [
    "node_modules",
    "dist",
    "**/*.test.ts",
    "**/*.spec.ts"
  ],
  "modules": {
    "UserModule": ["user/**"],
    "TodoModule": ["todo/**"],
    "CoreModule": ["core/**"]
  }
}

Configuration Options

Option	Type	Description	Default
sourceDir	string	Source directory to analyze	"./src"
outputPath	string	Output file path for generated container	"container.gen.ts"
interface	string	File pattern for interfaces	"I*.ts"
exclude	string[]	Patterns to exclude from analysis	[]
modules	object	Module groupings (optional)	undefined

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