# Rainbow CLI NG

**rainbow-cli-ng** is a command-line tool for interacting with the Rainbow CPaaS REST API.

It supports multiple authentication methods (API key, user credentials, OAuth), profile-based connection management with OS keyring secret storage, and an interactive API documentation browser with live endpoint testing.

## Features

- **Multi-profile** — switch between sandbox, staging, and production environments; run any command under a specific profile with `--profile <name>` without changing your active configuration
- **Three auth methods** — `API_KEY`, `RAINBOW` (user/password), `OAUTH` (browser flow)
- **API documentation browser** — interactive TUI to explore and test all Rainbow CPaaS endpoints
- **Webhook listener** — receive company events in real time via smee.io or a custom tunnel
- **UCS S2S listener** — persistent Rainbow connection via an HTTP webhook (ngrok recommended)
- **Natural language queries** — ask questions about your Rainbow data using Anthropic Claude or Mistral AI
- **MCP server** — expose Rainbow CPaaS to any MCP-compatible client (Claude Desktop, Claude Code…)

## Requirements

- **Node.js 20.12+**

## Installation

```bash
npm install -g rainbow-cli-ng-<version>.tgz
rainbow-cli-ng --help
```

## Quick start

```bash
# 1. Create a connection profile
rainbow-cli-ng config create-profile

# 2. Verify the connection
rainbow-cli-ng whoami

# 3. Explore the API
rainbow-cli-ng api-docs browse
```

## Documentation

- [Quick Start — Français](./QUICKSTART_fr.md)
- [Quick Start — English](./QUICKSTART_en.md)
- [Quick Start — Deutsch](./QUICKSTART_de.md)
- [MCP Integration — Français](./MCP_fr.md)
- [MCP Integration — English](./MCP_en.md)
- [JS Scripting Guide](./guides/JS_SCRIPTING_GUIDE.md)
- [Webhook Listener Guide](./guides/WEBHOOK_LISTENER_GUIDE.md)
- [UCS S2S API Guide](./guides/UCS_S2S_API_GUIDE.md)
- [Room Admin API Guide](./guides/ROOM_ADMIN_GUIDE.md)
