Skip to content

External: Using EAC in Your Project

Reference documentation for developers adopting EAC in their own repositories.

Overview

EAC (Everything as Code) provides automation for:

  • Building and testing modules
  • Generating documentation
  • Managing releases
  • Security scanning
  • AI-powered workflows

In This Section

Topic Description
Getting Started First steps adopting EAC
Configuration Configure EAC for your project
Project Structure Recommended .eac/ directory layout

Quick Start

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

# 2. Initialize EAC in your project
eac init

# 3. Start using commands
eac show modules
eac validate

What EAC Provides

Module Management

Define modules with dependencies, file ownership, and build configuration:

# .eac/repository.yml
modules:
  - moniker: my-service
    type: go-cli
    depends_on: [my-library]

Automation Commands

Many commands for common tasks:

eac build <module>      # Build modules
eac test <module>       # Run tests
eac validate            # Validate configuration
eac scan                # Security scanning

AI-Powered Features

With an AI provider configured:

eac get commit-message      # Generate commit messages
eac create pr              # Create PRs with AI descriptions
eac create spec            # Generate Gherkin specifications

Requirements

  • Git - Version control
  • CLIE CLI - Optional, for containerized execution

Next Steps

  1. Getting Started - Detailed setup guide
  2. Configuration - Customize EAC for your needs
  3. Project Structure - Organize your .clie/ directory

See Also


Tutorials | How-to Guides | Explanation | Reference

You are here: Reference — information-oriented technical descriptions of the system.