@evolith/cli

Evolith SDK CLI

Welcome to the official Evolith CLI. This tool is designed to automate the adoption of Evolith standards, architecture, and governance in satellite repositories.

Language: English | Español

Installation

You can install the tool globally via NPM:

npm install -g @evolith/cli

Or run it on demand using npx:

npx @evolith/cli init

Main Commands

init

Interactively initializes a satellite repository, setting up bilingual documentation rules, base templates, and required agents. Supports interactive mode (wizard) and batch mode via --config evolith.setup.json.

agents

Installs and configures agents in your repository (e.g., bmad, architecture, qa).

evolith agents install

validate

Verifies that the repository complies with Evolith structure and rules (Mermaid, stable anchors, bilingual parity). Ideal for use in your CI/CD pipelines:

evolith validate --format json

daemon

Starts the background watcher and the MCP (Model Context Protocol) server to integrate with IDEs like VSCode or assistants like Antigravity.

evolith daemon start

sdlc

Orchestrates the generation of artifacts and transitions (Handoffs) between the lifecycle phases (Discovery, Design, Construction).

evolith sdlc init discovery
evolith sdlc handoff to-ddd --from backlog.json
evolith sdlc generate domain --from ddd-model.md

upgrade

Downloads the latest upstream Evolith rules, templates, and guidelines and intelligently applies them to the satellite without overwriting custom code (idempotent).

How-To

A typical workflow with the Evolith CLI in a satellite repository:

• Initialize the environment: Go to your project directory (or create it) and run the initialization command. This will set up the base rules, directory structures, and templates:

  npx @evolith/cli init
  

• Install the required agents: To add capabilities like QA validation or architecture design, install the preconfigured agents:

  evolith agents install
  

• Validate your repository (CI/CD): You can continuously validate (e.g., in a pre-commit hook or pipeline) that bilingual documentation, Mermaid diagrams, and links are correct:

  evolith validate --format json
  

Architecture

To learn about implementation details, technical decisions, and the domain model behind the CLI and the broader SDK, see the following architecture documentation:

• Evolith SDK Architecture
• Domain Model
• Technical Design

Governance

This CLI strictly adheres to the policies established in Evolith's AGENTS.md.