AgentReady

A Node.js + TypeScript CLI tool that checks if your AI agent environment is ready. Verify required binaries, environment variables, and permissions before running your agent.

Features

• Binary Checks — Verify presence and version of required tools (Node.js, Python, Git, Docker, Homebrew)
• Environment Variable Validation — Check for API keys with format validation
• Permission Checks — Ensure proper directory access
• Profile Support — Pre-configured profiles for different agent setups
• Auto-fix Suggestions — Get installation commands for missing dependencies

Quick Start

# Install globally
npm install -g agentready

# Run checks
agentready check

# Run with a specific profile
agentready check --profile openclaw
agentready check -p claude-code

Usage

check Command

Run environment readiness checks:

agentready check              # Run all default checks
agentready check --profile openclaw    # Use openclaw profile
agentready check -p claude-code        # Use claude-code profile

fix Command

Get suggested fixes for missing dependencies:

agentready fix                # Show all suggested fixes
agentready fix --profile openclaw       # Filter by profile

Profiles

Profile	Required Binaries	Use Case
default	None (checks all core binaries)	General environment check
openclaw	Node.js ≥20, Homebrew, Git	OpenClaw agent setup
claude-code	Node.js ≥20, Git	Claude Code integration

Example Output

$ agentready check

AgentReady - Environment Check

┌─────────────┬─────────────┬─────────────────────────────────┐
│ Category    │ Check       │ Status                          │
├─────────────┼─────────────┼─────────────────────────────────┤
│ binary      │ node        │ ✅ Found (v20.11.0)             │
│ binary      │ python3     │ ✅ Found (Python 3.11.7)        │
│ binary      │ git         │ ✅ Found (git version 2.39.0)  │
│ binary      │ docker      │ ⚠️ Found (Docker Desktop 4.25) │
│ binary      │ brew        │ ✅ Found (brew 4.2.0)           │
│ env         │ ANTHROPIC…  │ ❌ ANTHROPIC_API_KEY is not set │
│ env         │ OPENAI…    │ ❌ OPENAI_API_KEY is not set    │
│ permission  │ workspace   │ ✅ Workspace accessible         │
└─────────────┴─────────────┴─────────────────────────────────┘

Summary
┌──────────┬───────┐
│ Status   │ Count │
├──────────┼───────┤
│ Pass     │ 6     │
│ Fail     │ 2     │
│ Warn     │ 1     │
└──────────┴───────┘

Development Setup

# Clone the repository
git clone https://github.com/zseven-w/agentready.git
cd agentready

# Install dependencies
npm install

# Build TypeScript
npm run build

# Run locally
npm start -- check
npm start -- fix

Project Structure

agentready/
├── src/
│   ├── checks/           # Health check modules
│   │   ├── binaries.ts   # Binary availability checks
│   │   ├── env.ts        # Environment variable validation
│   │   ├── permissions.ts# Permission checks
│   │   └── run-all.ts    # Aggregate all checks
│   ├── commands/         # CLI commands
│   │   ├── check.ts      # check command implementation
│   │   └── fix.ts        # fix command implementation
│   ├── profiles/         # Agent profiles
│   │   └── index.ts      # Profile definitions
│   ├── utils/            # Utility functions
│   │   ├── render.ts     # Table rendering
│   │   └── shell.ts      # Shell command helpers
│   ├── types.ts          # TypeScript type definitions
│   └── index.ts          # CLI entry point
├── package.json
├── tsconfig.json
└── README.md

License

ISC License — see LICENSE for details.

Author

ZSeven-W