Package Exports
- chorenzo
- chorenzo/dist/main.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (chorenzo) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Chorenzo Engine
Open-source CLI engine that automates your engineering workflow with AI-powered workspace analysis and recipe application.
Usage
Initialize Workspace
Initialize your Chorenzo workspace and download recipe libraries:
# Initialize workspace with recipe libraries
npx chorenzo init
# Reset workspace and re-initialize
npx chorenzo init --reset
# Skip automatic workspace analysis
npx chorenzo init --no-analyze
# Or use alias
npx chorenzo init -A
# Skip interactive confirmation
npx chorenzo init -y
# Or combine with other options
npx chorenzo init --reset -y
# Show detailed debug output
npx chorenzo init --debug
# Show LLM cost information
npx chorenzo init --costAnalyze Command
Analyze your workspace and get detailed insights about project structure, dependencies, and ecosystems:
# With progress UI (default)
npx chorenzo analyze
# Disable progress UI for simple text output
npx chorenzo analyze --no-progress
# Show detailed debug output
npx chorenzo analyze --debug
# Show LLM cost information
npx chorenzo analyze --costRecipes Command
Validate, apply, and generate Chorenzo recipes to automate your workspace:
Validate Recipes
# Validate a recipe by name
npx chorenzo recipes validate code-formatting
# Validate a local recipe folder
npx chorenzo recipes validate ./my-recipe
# Validate an entire recipe library
npx chorenzo recipes validate ~/.chorenzo/recipes/core
# Validate recipes from a git repository
npx chorenzo recipes validate https://github.com/chorenzo-dev/recipes-core.git
# Disable progress UI for simple text output
npx chorenzo recipes validate code-formatting --no-progress
# Show detailed debug output
npx chorenzo recipes validate code-formatting --debugShow Recipe Details
Show detailed information about a specific recipe:
# Show details for a recipe by name
npx chorenzo recipes show code-formatting
# Show details for any available recipe
npx chorenzo recipes show testing-setup
# Disable progress UI for simple text output
npx chorenzo recipes show linting --no-progress
# Show detailed debug output
npx chorenzo recipes show ci-cd --debugApply Recipes
Apply automation recipes to your workspace:
# Apply a recipe by name
npx chorenzo recipes apply code-formatting
# Apply a local recipe folder
npx chorenzo recipes apply ./my-recipe
# Apply with custom variant
npx chorenzo recipes apply linting --variant strict
# Apply to specific project in monorepo
npx chorenzo recipes apply testing --project frontend
# Skip interactive confirmations
npx chorenzo recipes apply eslint-config -y
# Disable progress UI for simple text output
npx chorenzo recipes apply ci-cd --no-progress
# Show detailed debug output
npx chorenzo recipes apply linting --debug
# Show LLM cost information
npx chorenzo recipes apply code-formatting --cost
# Combine flags for detailed output
npx chorenzo recipes apply linting --cost --debug -yGenerate Recipes
Create new automation recipes for your workspace:
# Interactive recipe generation (prompts for all details)
npx chorenzo recipes generate
# Generate with recipe name
npx chorenzo recipes generate my-recipe
# Generate with all parameters specified
npx chorenzo recipes generate eslint-setup \
--category tools \
--summary "Set up ESLint and Prettier with TypeScript support for consistent code formatting"
# Generate to custom location
npx chorenzo recipes generate testing \
--location ~/my-recipes \
--category development \
--summary "Configure Jest testing framework with coverage reporting and TypeScript integration"
# Disable progress UI for simple text output
npx chorenzo recipes generate my-recipe --no-progress
# Show detailed debug output
npx chorenzo recipes generate my-recipe --debug
# Show LLM cost for AI-generated recipes
npx chorenzo recipes generate my-recipe --cost
# Generate ecosystem-agnostic recipe
npx chorenzo recipes generate docker-setup --ecosystem-agnostic \
--category infrastructure \
--summary "Add Docker support for any project type"
# Generate ecosystem-specific recipe
npx chorenzo recipes generate typescript-setup --ecosystem-specific \
--category tools \
--summary "Set up TypeScript configuration for JavaScript projects"
# Generate AI-powered recipe content
npx chorenzo recipes generate auth-system --magic-generate \
--category security \
--summary "Implement authentication system"
# Generate with additional AI instructions
npx chorenzo recipes generate api-endpoints --magic-generate \
--additional-instructions "Use FastAPI with async support" \
--category api \
--summary "Create REST API endpoints"Options:
--no-progress: Disable progress UI for simple text output--debug: Show detailed debug output with all progress messages--cost: Show LLM cost information (for AI-generated recipes)--location <path>: Custom save location (supports ~ for home directory)--category <category>: Recipe category (required for non-interactive mode)--summary <summary>: Recipe summary (required for non-interactive mode)--ecosystem-agnostic: Create recipe that works across multiple ecosystems (generates single fix.md file)--ecosystem-specific: Create recipe with separate fixes for each ecosystem (generates fix.md base file plus variants/ directory with ecosystem-specific files)--magic-generate: Generate recipe content using AI (uses Claude)--additional-instructions <instructions>: Additional instructions for AI generation (requires --magic-generate)
Interactive Mode: When run without required parameters, the generate command will prompt you interactively for:
- Recipe name (letters, numbers, and dashes only)
- Magic generation choice (AI-generated vs template-based)
- Save location (current workspace, home directory, or custom path)
- Category selection (with autocomplete from existing categories)
- Recipe summary (descriptive one-sentence explanation)
Non-interactive Mode: For automation and scripting, provide all required parameters:
--category: Recipe category (required)--summary: Descriptive summary (required)--location: Custom save location (optional, defaults to current directory)
Chorenzo uses atomic, composable automation recipes to handle workspace setup and configuration. Recipes operate at different levels with intelligent application logic:
- Workspace-only: Apply exclusively at workspace level (e.g., git hooks, global config)
- Project-only: Apply exclusively to individual projects (e.g., framework setup, project config)
- Workspace-preferred: Apply at workspace level when possible, fall back to projects for mixed ecosystems
Recipes can conditionally apply based on project and workspace characteristics from your analysis.json:
# Recipe that only applies to Python projects
requires:
- key: project.ecosystem
equals: python
# Recipe that requires a monorepo workspace
requires:
- key: workspace.is_monorepo
equals: trueSee our recipes documentation for detailed information about creating and using recipes, including the full list of available project characteristics.
Common Flags
Most commands support these common flags:
--no-progress: Disable progress UI for simple text output--debug: Show detailed debug output with all progress messages--cost: Show LLM cost information (for commands that use AI)
Help
# Show all available commands
npx chorenzo --help
# Show help for specific command
npx chorenzo init --help
npx chorenzo analyze --help
npx chorenzo recipes --help
# Show help for recipe subcommands
npx chorenzo recipes validate --help
npx chorenzo recipes show --help
npx chorenzo recipes apply --help
npx chorenzo recipes generate --helpRequirements
- Node.js 18+
- Git repository (workspace must be in a Git repository)
- Claude Code API access
License
Apache-2.0