agentready

# AgentReady

<p align="center">
  <a href="https://github.com/zseven-w/agentready/actions"><img src="https://img.shields.io/github/actions/workflow/status/zseven-w/agentready/test.yml" alt="Build"></a>
  <a href="https://www.npmjs.com/package/agentready"><img src="https://img.shields.io/npm/v/agentready" alt="npm"></a>
  <a href="https://www.npmjs.com/package/agentready"><img src="https://img.shields.io/npm/dt/agentready" alt="npm downloads"></a>
  <a href="LICENSE"><img src="https://img.shields.io/github/license/zseven-w/agentready" alt="ISC License"></a>
</p>

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

```bash
# 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:

```bash
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:

```bash
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 |
|