Skip to content

CONTAINER.md

Latest commit

 

History

History
213 lines (162 loc) · 4.71 KB

CONTAINER.md

File metadata and controls

213 lines (162 loc) · 4.71 KB

AgentReady Container

Size-optimized container (683 MB) for headless environments and CI/CD.

Quick Start

# Pull latest
podman pull ghcr.io/ambient-code/agentready:latest

# Create output directory
mkdir -p ~/agentready-reports

# Assess repository
podman run --rm \
  -v /path/to/repo:/repo:ro \
  -v ~/agentready-reports:/reports \
  ghcr.io/ambient-code/agentready:latest \
  assess /repo --output-dir /reports

# Open reports
open ~/agentready-reports/report-latest.html

Usage

Assess AgentReady Itself

# Clone AgentReady
git clone https://github.com/ambient-code/agentready /tmp/agentready

# Create output directory
mkdir -p ~/agentready-reports

# Run assessment
podman run --rm \
  -v /tmp/agentready:/repo:ro \
  -v ~/agentready-reports:/reports \
  ghcr.io/ambient-code/agentready:latest \
  assess /repo --output-dir /reports

# Open reports
open ~/agentready-reports/report-latest.html

Assess Your Repository

# Create output directory
mkdir -p ./agentready-reports

# Local repository
podman run --rm \
  -v $(pwd):/repo:ro \
  -v $(pwd)/agentready-reports:/reports \
  ghcr.io/ambient-code/agentready:latest \
  assess /repo --output-dir /reports

# With additional options
podman run --rm \
  -v $(pwd):/repo:ro \
  -v $(pwd)/agentready-reports:/reports \
  ghcr.io/ambient-code/agentready:latest \
  assess /repo --output-dir /reports --verbose

# Exclude specific assessors
podman run --rm \
  -v $(pwd):/repo:ro \
  -v $(pwd)/agentready-reports:/reports \
  ghcr.io/ambient-code/agentready:latest \
  assess /repo --output-dir /reports -e type_annotations -e test_coverage

Save Output Files

# Mount writable output directory
podman run --rm \
  -v /path/to/repo:/repo:ro \
  -v $(pwd)/reports:/reports \
  ghcr.io/ambient-code/agentready:latest \
  assess /repo --output-dir /reports

# Reports saved: report-*.html, report-*.md, assessment-*.json

Available Tags

  • latest - Latest stable release
  • 2.13.0 - Specific version
  • 2.13 - Major.minor version
  • 2 - Major version
# Pin to specific version
podman pull ghcr.io/ambient-code/agentready:2.13.0

Multi-Architecture Support

Supports both amd64 and arm64:

# Automatically pulls correct architecture
podman pull ghcr.io/ambient-code/agentready:latest

Docker Compatibility

Replace podman with docker:

docker pull ghcr.io/ambient-code/agentready:latest
docker run --rm \
  -v $(pwd):/repo:ro \
  -v $(pwd)/agentready-reports:/reports \
  ghcr.io/ambient-code/agentready:latest \
  assess /repo --output-dir /reports

CI/CD Integration

GitHub Actions

- name: Run AgentReady Assessment
  run: |
    mkdir -p reports
    docker pull ghcr.io/ambient-code/agentready:latest
    docker run --rm \
      -v ${{ github.workspace }}:/repo:ro \
      -v ${{ github.workspace }}/reports:/reports \
      ghcr.io/ambient-code/agentready:latest \
      assess /repo --output-dir /reports

- name: Upload reports
  uses: actions/upload-artifact@v4
  with:
    name: agentready-reports
    path: reports/

GitLab CI

agentready:
  image: ghcr.io/ambient-code/agentready:latest
  script:
    - mkdir -p reports
    - agentready assess . --output-dir reports
  artifacts:
    paths:
      - reports/

Building Locally

# Clone repository
git clone https://github.com/ambient-code/agentready
cd agentready

# Build container
podman build -t agentready:local -f Containerfile.scratch .

# Test
podman run --rm agentready:local --version

Technical Details

  • Base: python:3.12-slim
  • Size: 683 MB
  • User: UID 1001 (non-root)
  • Source: PyPI (always latest agentready release)
  • Output: stdout/stderr (no volume mounts required)

Troubleshooting

Reports not accessible on host

Mount a writable output directory to save reports to your host filesystem:

mkdir -p ~/agentready-reports
podman run --rm \
  -v /repo:/repo:ro \
  -v ~/agentready-reports:/reports \
  ghcr.io/ambient-code/agentready:latest \
  assess /repo --output-dir /reports

Without the -v ~/agentready-reports:/reports mount, reports written to /tmp inside the container are destroyed when the container exits.

Permission denied on mounted volumes

Add SELinux context (:Z flag) on SELinux systems:

podman run --rm \
  -v $(pwd):/repo:ro,Z \
  -v $(pwd)/agentready-reports:/reports,Z \
  ghcr.io/ambient-code/agentready:latest \
  assess /repo --output-dir /reports

Links