Metadata-Version: 2.4
Name: ceorater
Version: 1.0.1
Summary: CLI for CEORater — institutional-grade CEO performance analytics
Author-email: Jon Maietta <support@ceorater.com>
License: Proprietary
Project-URL: Homepage, https://www.ceorater.com
Project-URL: Documentation, https://www.ceorater.com/api-docs.html
Project-URL: Support, https://www.ceorater.com/support.html
Keywords: ceo,finance,investing,analytics,sec
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: click>=8.0
Requires-Dist: requests>=2.28
Requires-Dist: rich>=13.0

# CEORater CLI

Command-line interface for [CEORater](https://www.ceorater.com) — institutional-grade CEO performance analytics covering 500+ S&P 500 CEOs.

![CEORater CLI homepage](https://raw.githubusercontent.com/jmaietta/ceorater-cli/main/docs/screenshots/ceorater-home.png)

## Install

```bash
pip install ceorater
```

## Setup

Get your API key at [ceorater.com/api-docs.html](https://www.ceorater.com/api-docs.html), then set the `CEORATER_API_KEY` environment variable.

PowerShell:

```powershell
$env:CEORATER_API_KEY="your-api-key"
```

macOS/Linux:

```bash
export CEORATER_API_KEY="your-api-key"
```

## Commands

Run the terminal:

```bash
ceorater
```

The interactive prompt uses slash commands:

| Command | Description |
|---------|-------------|
| `/ticker` | CEO Analytics by ticker |
| `/list` | List CEOs |
| `/status` | Dataset freshness and API status |
| `/help` | Show command menu |
| `/exit` | Quit |

### Look up a CEO by ticker

```bash
ceorater
/NVDA
```

```
  NVIDIA (NVDA)
  CEO: Jensen Huang  |  Founder: Yes  |  Tenure: 27.3 yrs
  Sector: Technology  |  Industry: Semiconductors

  Metric                  Value
  CEORaterScore              99
  AlphaScore                100
  RevCAGR Score             100
  CompScore                   A

  TSR Multiple         589,250%
  Avg Annual TSR        21,578%
  TSR vs SPY           588,370%
  Avg Annual vs SPY     21,546%

  Compensation ($M)      $49.9M
  Cost/1% TSR ($M)        $0.0M
  Revenue CAGR            69.3%
```

### List all CEOs (paginated)

```bash
ceorater
/list
```

### Check data freshness

```bash
ceorater
/status
```

### JSON output for agents and scripts

The standard subcommands remain available for scripts. Data commands support `--json` for raw, machine-readable output:

```bash
ceorater lookup AAPL --json
```

```json
{
  "companyName": "Apple Inc.",
  "ticker": "AAPL",
  "ceoraterScore": 76.2,
  "alphaScore": 93.9,
  "compScore": "C",
  ...
}
```

## Metrics

| Metric | Description |
|--------|-------------|
| CEORaterScore | Composite CEO effectiveness rating (0-100) |
| AlphaScore | Market outperformance score (0-100) |
| RevCAGR Score | Tenure-adjusted revenue growth percentile (0-100) |
| CompScore | Compensation efficiency grade (A-F) |
| TSR Multiple | Total Shareholder Return during tenure |
| Cost/1% TSR | CEO compensation cost per 1% of average annual TSR |

## Requirements

- Python 3.9+
- CEORater API subscription ($99/month) — [subscribe here](https://www.ceorater.com/api-docs.html)

## License

Proprietary. See [terms of service](https://www.ceorater.com/terms.html).
