Getting Started with EAC

First steps for adopting EAC in your repository.

Prerequisites

Before starting:

[ ] Git repository initialized
[ ] Terminal access (bash, zsh, or PowerShell)

Step 1: Install EAC CLI

Linux/macOS

curl -fsSL https://raw.githubusercontent.com/ready-to-release/eac/main/scripts/sh/eac/install.sh | bash

Windows

irm https://raw.githubusercontent.com/ready-to-release/eac/main/scripts/pwsh/eac/install.ps1 | iex

Verify Installation

eac version

Step 2: Initialize EAC

eac init

This creates the .eac/ directory with default configuration.

Step 3: Verify Setup

# Show modules
eac show modules

# Validate configuration
eac validate

# Check module dependencies
eac show dependencies

Step 4: Define Your First Module

Edit .eac/repository.yml:

modules:
  - moniker: my-app
    name: My Application
    type: go-cli
    files:
      root: cmd/my-app
      source: ["**/*.go"]

Optional: Configure AI Provider

For AI-powered features (commit messages, PR descriptions):

# Set API key environment variable
export ANTHROPIC_API_KEY="sk-ant-..."

# Initialize AI provider
eac init --ai claude-api

What You Now Have

After setup, your project includes:

your-project/
├── .eac/
│   └── repository.yml    # Module definitions
└── ... (your code)

Alternative: CLIE Container Host

If you need containerized execution via Docker:

# Install CLIE CLI
curl -fsSL https://raw.githubusercontent.com/ready-to-release/eac/main/scripts/sh/cli/install.sh | bash

# Initialize and install EAC extension
clie init
clie install eac

Common First Commands

# View all modules
eac show modules

# Validate all contracts
eac validate

# Show available commands
eac help

# Build a module
eac build my-app

# Run tests
eac test my-app

Troubleshooting

Problem	Solution
"Command not found"	Add install directory to PATH
"Module not found"	Check `repository.yml` syntax
"Invalid type"	Use valid component type (go, typescript, etc.)

Next Steps

Configuration - Customize EAC settings
Project Structure - Organize configuration files
Command Reference - Explore all commands