frai/README.md

Responsible AI compliance framework - Generate comprehensive documentation in under 3 minutes

# FRAI - Responsible AI in Minutes

![npm version](https://img.shields.io/npm/v/frai)

FRAI is a responsible AI compliance framework that generates comprehensive documentation in under 3 minutes. It guides you through a progressive, context-aware questionnaire and produces:
- Implementation Checklist
- Model Card
- Risk & Compliance File

## 🚀 Getting Started

**1. Install FRAI globally:**
```bash
npm install -g frai
```

**2. Set up your OpenAI API key (required for AI-powered tips):**
```bash
frai --setup
```
You only need to do this once per machine or project. Your key is stored securely and never shared.

**3. Run FRAI in your project:**
```bash
frai
```

---

## 🛠️ CLI Commands & Features

| Command                | Description |
|------------------------|-------------|
| `frai`                 | Interactive mode for documenting an AI feature (8-question progressive system) |
| `frai --scan`          | Scan codebase for AI/ML code and generate docs |
| `frai --setup`         | Set up your OpenAI API key (local/global) |
| `frai --ci`            | Run in CI mode (non-interactive) |
| `frai --help`, `-h`    | Show help and usage info |
| `frai --version`, `-v` | Show current version |
| `frai --update`        | Check for new versions of FRAI |
| `frai --list-docs`     | List generated documentation files |
| `frai --clean`         | Remove generated documentation files |
| `frai --export-pdf`    | Export documentation markdown files as PDFs |
| `frai --show-config`   | Show API key config status |
| `frai --key=API_KEY`   | Provide OpenAI API key directly (one-off use) |
| `frai --global`        | Use with --setup to save API key globally |

**Docs generated:**
- `checklist.md`      — Implementation checklist
- `model_card.md`     — Model card
- `risk_file.md`      — Risk & compliance

---

## 💡 Features
- **Progressive 8-question system**: Context-aware, fast, and actionable
- **AI-powered recommendations**: Get tailored tips for responsible AI
- **Comprehensive documentation**: Checklist, model card, and risk file
- **PDF export**: Convert docs to PDF with one command
- **Codebase scanning**: Detects AI/ML code and generates relevant docs
- **Easy setup**: One-time API key configuration

---

## 🔑 API Key Setup
FRAI requires an OpenAI API key for generating AI-powered tips and documentation. Run:
```bash
frai --setup
```
If you skip this step, FRAI will prompt you to set up your key on first use.

---

## 📖 Learn More
- [GitHub Repository](https://github.com/sebastianbuzdugan/frai)
- [NPM Package](https://www.npmjs.com/package/frai)

---

*Generated by FRAI - Responsible AI in Minutes*