Skip to main content

Installation

Prerequisites​

  • Node.js 20+ (for CDK projects)
  • Docker 24+ (for DevContainer)
  • Git 2.x (for submodules)

Consumer Setup (5 minutes)​

# Add ADLC framework as submodule
cd your-project
git submodule add https://github.com/1xOps/adlc-framework.git .adlc

# Create symlinks for Claude Code
ln -s .adlc/.claude .claude
ln -s .adlc/.specify .specify

# Initialize submodule
git submodule update --init --recursive
# For local development with symlink
ln -s /path/to/adlc-framework .adlc
ln -s .adlc/.claude .claude
ln -s .adlc/.specify .specify

Framework Management Tasks​

Add these to your Taskfile.yml:

version: '3'

tasks:
  framework:version:
    desc: Show ADLC framework version
    cmds:
      - |
        cd .adlc
        VERSION=$(git describe --tags 2>/dev/null || git rev-parse --short HEAD)
        echo "ADLC Framework: $VERSION"

  framework:update:
    desc: Update framework to latest
    cmds:
      - git submodule update --remote .adlc
      - cd .adlc && git checkout main && git pull

  framework:dev:
    desc: Switch to symlink mode for development
    cmds:
      - rm -rf .adlc
      - ln -s /path/to/local/adlc-framework .adlc

  framework:prod:
    desc: Switch back to submodule mode
    cmds:
      - rm -f .adlc
      - git submodule update --init .adlc

DevContainer Setup​

Open in VS Code with DevContainer:

  1. Install "Dev Containers" VS Code extension
  2. Open project folder
  3. Press F1 → "Dev Containers: Reopen in Container"

The DevContainer includes:

  • Terraform 1.14.3
  • AWS CDK 2.1033.0
  • LocalStack endpoint pre-configured
  • 30+ DevOps tools

Verify Installation​

# Check framework version
task framework:version

# Validate constitutional compliance
task spec:validate