Package Exports

@aiready/cli
@aiready/cli/dist/index.js
@aiready/cli/dist/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aiready/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@aiready/cli

Unified command-line interface for the AIReady framework.

🏛️ Architecture

# @aiready/cli

> Unified command-line interface for the AIReady framework.

## 🏛️ Architecture

                🎯 USER
                  │
                  ▼
     🎛️  @aiready/cli (orchestrator)  ← YOU ARE HERE
      │     │     │     │     │     │     │     │     │
      ▼     ▼     ▼     ▼     ▼     ▼     ▼     ▼     ▼
    [PAT] [CTX] [CON] [AMP] [DEP] [DOC] [SIG] [AGT] [TST]
      │     │     │     │     │     │     │     │     │
      └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
                           │
                           ▼
                  🏢 @aiready/core

Legend: PAT = pattern-detect CTX = context-analyzer CON = consistency AMP = change-amplification DEP = deps-health DOC = doc-drift SIG = ai-signal-clarity AGT = agent-grounding TST = testability


## Language Support

Analyzes **TypeScript, JavaScript, Python, Java, Go, and C#** (95% market coverage).

## Overview

The CLI provides both unified analysis (scan multiple tools at once) and individual tool access for pattern detection, context analysis, and consistency checking.

## Usage

```bash
# Scan a codebase
aiready scan .

# Run a specific tool
aiready patterns . --similarity 0.6
```

## 🛠️ Building Your Own Tool (Spokes)

Want to build your own analysis tool that integrates with the AIReady ecosystem? Check out our [Spoke Development Guide](./docs/SPOKE_GUIDE.md).

## 🌐 Platform Integration


Connect your local scans to the [AIReady Dashboard](https://platform.getaiready.dev/dashboard).

### Automatic Upload

Scan and upload results in one step:

```bash
aiready scan . --upload --api-key ar_...
```

### Manual Upload

Upload an existing report JSON:

```bash
aiready upload .aiready/latest.json --api-key ar_...
```

### Options

- `--upload`: Automatically upload results after scan
- `--api-key <key>`: Your platform API key (or set `AIREADY_API_KEY`)
- `--server <url>`: Custom platform URL (optional)

## License

MIT

```

```