Content
# rimo
[English](README.en.md) | [日本語](README.md)
`rimo` is the command-line interface for the [Rimo Voice](https://rimo.app) platform. It allows you to search, retrieve, and query meeting notes from your terminal.
Built for both humans and AI agents (such as Claude Code, Codex, etc.). All commands output JSON by default, and behavior can be verified with `--help`, making it easy to incorporate into your scripts or agent workflows.
> **This is the official distribution repository.** Obtain binaries only from [Releases](https://github.com/rimo/cli/releases) and verify them with the published `checksums.txt` (see [installation](docs/en/installation.md)).
## Installation
```bash
curl -fsSL https://rimo.app/cli/install.sh | sh
```
This will install the latest `rimo` binary in `~/.local/bin`. See [installation](docs/en/installation.md) for other options, upgrades, and uninstallation.
## Quickstart
```bash
rimo auth login # Browser-based secure login (token stored securely by OS)
rimo note list # List notes (JSON)
rimo note get <id> # Get a single note
```
```bash
rimo note search "Q3 release plan" # Search notes semantically
rimo note ask "what did we decide on pricing?" # Generate answers from notes with AI
```
## Commands
All commands output JSON to stdout by default. (See [rationale and exceptions →](docs/en/output-and-errors.md))
| Command | Description |
|---------|-------------|
| [`rimo auth login`](docs/en/commands.md#rimo-auth-login) | Authenticate with browser-based login |
| [`rimo auth logout`](docs/en/commands.md#rimo-auth-logout) | Invalidate token and remove stored account |
| [`rimo auth status`](docs/en/commands.md#rimo-auth-status) | Display authenticated account |
| [`rimo auth switch`](docs/en/commands.md#rimo-auth-switch) | Switch active account |
| [`rimo note list`](docs/en/commands.md#rimo-note-list) | List notes (with `--attended`, `--team`, `--since`/`--until`, `--updated-since`) |
| [`rimo note get`](docs/en/commands.md#rimo-note-get) | Get a note by ID (metadata, transcript, documents) |
| [`rimo note search`](docs/en/commands.md#rimo-note-search) | Search notes semantically or by keyword |
| [`rimo note ask`](docs/en/commands.md#rimo-note-ask) | Ask a question and get an integrated answer from AI |
| [`rimo team list`](docs/en/commands.md#rimo-team-list) | List teams in your organization |
| [`rimo version`](docs/en/commands.md#rimo-version) | Display CLI version |
| [`rimo upgrade`](docs/en/commands.md#rimo-upgrade) | Self-upgrade to the latest release |
See [commands](docs/en/commands.md) for the complete reference.
## Global Flags
```
--account <alias> Use the specified account alias (overrides active_account in config)
--fields <spec> Include fields: "" (all), "compact", or "field1,field2"
--excludes <list> Exclude fields from output (comma-separated)
--dry-run Simulate command without side effects (write operations only)
```
## Documentation
- [Installation](docs/en/installation.md) — Installation, upgrades, and uninstallation
- [Authentication](docs/en/authentication.md) — Browser-based login and accounts
- [Personal API Keys](docs/en/personal-api-keys.md) — Create keys in the web app and authenticate with `RIMO_API_KEY` for CI/CD
- [Commands](docs/en/commands.md) — Complete reference with flags and examples
- [Configuration](docs/en/configuration.md) — `config.yaml`, credential storage, and environment variables
- [Output and Errors](docs/en/output-and-errors.md) — JSON design, `--fields`/`--excludes`, and exit codes
- [MCP Server](docs/en/mcp.md) — Expose `rimo` as a typed tool for MCP clients like Claude Code, Codex, and Cursor
- [Troubleshooting](docs/en/troubleshooting.md) — Common issues with installation, login, and PATH
## AI Agents
`rimo` provides two ways to integrate with AI coding agents like Claude Code, Codex, and Cursor. Both can be used together. If you're using Claude Code, the easiest way is to install the plugin with a single command.
### Claude Code Plugin (install skills with one command)
The `rimo` plugin includes an [agent skill](skills/rimo-cli/SKILL.md) that can be installed in one command:
```
/plugin marketplace add rimo/cli
/plugin install rimo@rimo
```
This repository doubles as a marketplace, so there are no external repository dependencies. You'll also need to install the `rimo` binary in your `$PATH` and authenticate with `rimo auth login`. The agent can use all features through the `rimo` CLI. If you want typed tools (MCP), use the MCP Server below.
### MCP Server (typed tools for MCP clients)
Running `rimo mcp` exposes the CLI as a typed tool over [Model Context Protocol](https://modelcontextprotocol.io). Add an entry to Claude Code's `.mcp.json`:
```json
{
"mcpServers": {
"rimo": { "type": "stdio", "command": "rimo", "args": ["mcp"] }
}
}
```
Restart the client and query it in natural language:
- *“Summarize Rimo’s notes from this week”*
- *“Find Rimo’s notes about the Q3 release plan”*
See [MCP Server](docs/en/mcp.md) for full setup with other MCP clients like Claude Code, Codex, and Cursor.
### Agent Skill (for any agent that can run shell commands)
`rimo` also includes an [agent skill](skills/rimo-cli/SKILL.md) — a self-contained walkthrough that any agent can read and use to execute shell commands. Use this if your agent doesn't support MCP or you want a single artifact to paste into your system prompt.
```bash
# Per-project (commit with repository)
mkdir -p .claude/skills/rimo-cli
curl -fsSL https://raw.githubusercontent.com/rimo/cli/main/skills/rimo-cli/SKILL.md \
-o .claude/skills/rimo-cli/SKILL.md
# Or system-wide (available to all projects)
mkdir -p ~/.claude/skills/rimo-cli
curl -fsSL https://raw.githubusercontent.com/rimo/cli/main/skills/rimo-cli/SKILL.md \
-o ~/.claude/skills/rimo-cli/SKILL.md
```
For Codex and other agents, either load the installed file at session start (e.g., `cat ~/.claude/skills/rimo-cli/SKILL.md`) or include its contents in your system prompt.
## Support
If you find a bug or have a feature request, create an issue in this repository.
## Security
See [Security Policy](SECURITY.md) for vulnerability reporting. Please do not report security issues in public issues.
## License
This project is not open-source. Use of Rimo CLI is subject to [Rimo Terms of Use](https://rimo.app/policies/terms). See [NOTICE](NOTICE.md).
