コマンド
すべての rimo コマンドの完全なリファレンスです。インストールについては インストール を、出力の取り決めとエラー形式については 出力とエラー を参照してください。
出力の取り決め。 すべてのコマンドはデフォルトで stdout に JSON を出力します。 一部の人間向けコマンドは成功時にプレーンテキストを出力します(エラーは常に JSON): rimo version、rimo upgrade、rimo note ask、および --transcript / --document / --full / --meeting-chat / --document-id を指定した rimo note get。
グローバルフラグ(すべてのコマンドに適用):
| フラグ | 説明 |
|---|---|
--account | 使用するアカウントのエイリアス(設定の active_account を上書き) |
--fields | 含めるフィールド: "" (すべて)、"compact"、または "f1,f2" |
--excludes | 出力から除外するフィールド(カンマ区切り) |
--dry-run | 副作用なしでコマンドをシミュレーション(書き込み系のみ) |
認証
rimo auth login
ブラウザベースのログインで Rimo に認証します。
構文
rimo auth login(トップレベルの rimo login としても利用できます。)
フロー
デフォルトでは、rimo auth login はブラウザを開きます:
- 既定のブラウザを開き、この CLI の認可ページに遷移します。
- 必要に応じてサインインし、リクエストを承認するのを待機します。
- アクセストークンとリフレッシュトークンを OS の認証情報ストアに安全に保存します。
~/.config/rimo/config.yamlにエイリアスを登録し、アクティブに設定します。
--no-browser フロー
ブラウザが利用できない環境向け:
- URL を stderr に出力します。
- 別の端末でその URL を開き、必要に応じてサインインしてリクエストを承認します。 ページに短いコードが表示されます。
- プロンプトでそのコードをターミナルに貼り付けます。
- 上記と同様にトークンを保存し、エイリアスを登録します。
フラグ
| フラグ | 説明 |
|---|---|
--no-browser | 別の端末で開く URL を出力し、表示された短いコードをターミナルに貼り付ける形式でログインします。 |
エイリアスの生成。 メールアドレスと組織名から自動生成されます:
| メール | 組織名 | 生成されるエイリアス |
|---|---|---|
alice@rimo.app | (空) | alice-rimo-personal |
alice@rimo.app | "Client A" | alice-rimo-client-a |
bob@gmail.com | "Acme Co" | bob-gmail-acme-co |
同じ (user_id, org_id) で再ログインすると、元のエイリアスを維持してメタデータを 更新します。
出力(stdout, JSON)
{
"status": "logged_in",
"alias": "alice-rimo-personal",
"email": "alice@rimo.app",
"name": "Alice",
"org": "Personal"
}rimo auth logout
トークンを失効させ、設定と認証情報ストアからアカウントを削除します。
構文
rimo auth logout [--account <alias|email|org>]--account を省略した場合、アクティブなアカウントがログアウトされます。アクティブな アカウントが設定されていない場合は、保存済みアカウントを一覧表示し、--account での 指定を求めます。
挙動
- 入力を正確なエイリアスに解決します(エイリアス → メール → 組織名の順)。
- 失効エンドポイントを呼び出します(ベストエフォート。失敗は stderr に記録されますが、 中断はしません)。
- OS の認証情報ストアからトークンを削除します。
config.yamlからアカウントを削除します。アクティブだった場合は、アクティブ アカウントがクリアされます(自動昇格はありません)。
出力(stdout, JSON)
{
"status": "logged_out",
"alias": "alice-rimo-personal",
"active_account": ""
}rimo auth status
保存済みのすべてのアカウントとそのトークン状態を一覧表示します。
構文
rimo auth status出力(stdout, JSON)
{
"active_account": "alice-rimo-personal",
"accounts": [
{
"alias": "alice-rimo-personal",
"email": "alice@rimo.app",
"name": "Alice",
"org": "Personal",
"active": true,
"token_status": "valid"
}
]
}token_status の値: valid、expiring_soon、expired、unknown (トークンの有効期限を判定できなかった)。
rimo auth switch
アクティブなアカウントを切り替えます。
構文
rimo auth switch <alias|email|org-name> [--org <org-name>]rimo auth use としても利用できます。
解決の順序
aliasの完全一致。emailの一致 —emailが複数の組織に対応し、--orgが指定されていない場合はエラーになります。org-nameの一致。 - 現在有効なメールアドレスが所属する組織が優先されます。
フラグ
| フラグ | 説明 |
|---|---|
--org | メールアドレスが複数の組織に登録されている場合に曖昧さを解消するための組織名。 |
例
rimo auth switch alice-rimo-personal # 完全なエイリアス
rimo auth switch alice@rimo.app # メールで指定(複数組織の場合はエラー)
rimo auth switch "Client A" # 組織名で指定
rimo auth switch alice@rimo.app --org "Client B" # メール + 組織で曖昧さを解消出力(stdout, JSON)
{
"status": "switched",
"alias": "alice-rimo-client-a",
"email": "alice@rimo.app",
"name": "Alice",
"org": "Client A"
}note
ノートコマンドが返す内容はアクセス権によって異なります:
rimo note list(デフォルト)は自分が所有するノートのみを返します。rimo note list --attendedは自分が参加したノートを返します。rimo note list --team <id>はチームのメンバー全員のノートを返します (そのチームのメンバーである必要があります)。チーム ID はrimo team listで取得できます。- URL のみで共有された(所有や参加によらない)ノートはどの一覧にも表示されませんが、 ID があれば
rimo note get <id>で直接取得できます。 - アクセスできないノートに対する
rimo note getは、ノートの存在を明かさずに not-found エラーを返します。
rimo note create と rimo note append は書き込み系で、notes:write スコープを 持つトークンが必要です(append はさらにノートの編集権限が必要)。それ以外の note コマンドはすべて読み取り専用です。
rimo note list
ノートを一覧表示します。
構文
rimo note list [--attended] [--team <id>] [--today] [--week]
[--since <date>] [--until <date>] [--updated-since <date>]
[--page-size <int>] [--page-token <string>]デフォルトモード。 認証済みユーザーが作成したノートを一覧表示します。
--attended モード。 認証済みユーザーが参加したノートを一覧表示します。
--team モード。 チームのメンバー全員のノートを一覧表示します。そのチームの メンバーである必要があり、そうでない場合はリクエストが拒否されます。--attended は --team や日付フィルタと併用できません。
--since / --until は打ち合わせ日時(ノートの held_at。設定がない場合は作成日時)で絞り込みます。 --updated-since は更新日時で絞り込むため、前回の取得以降に変更されたノートだけを取得したいときに便利です。 日付は YYYY-MM-DD(JST として解釈)または RFC3339 形式で指定できます。--until はその日時を含みません。
--today と --week は、よく使う held_at の範囲へのショートカットです。--today は 今日開催されたノート、--week は直近 7 日間(今日とその前 6 日間)に開催されたノートを 一覧表示します。いずれも JST で評価され、--since/--until を手動で指定した場合と完全に 同じ動作になるため、--since/--until(および相互、--attended)とは併用できません。
すべてのモードで --page-size と --page-token でページネーションできます。
フラグ
| フラグ | 型 | デフォルト | 説明 |
|---|---|---|---|
--attended | bool | false | 参加したノートを一覧表示 |
--team | string | "" | チームのメンバー全員のノートを一覧表示(チーム ID は rimo team list) |
--today | bool | false | 今日開催されたノートのショートカット(JST)。--since/--until と併用不可 |
--week | bool | false | 直近 7 日間に開催されたノートのショートカット(JST)。--since/--until と併用不可 |
--since | string | "" | この日時以降に開催されたノートのみ(YYYY-MM-DD または RFC3339) |
--until | string | "" | この日時より前に開催されたノートのみ(YYYY-MM-DD または RFC3339) |
--updated-since | string | "" | この日時以降に更新されたノートのみ(YYYY-MM-DD または RFC3339) |
--page-size | int | 0 | ページサイズ(0 の場合はサーバー側のデフォルトに従う) |
--page-token | string | "" | 前回の呼び出しの next_page_token |
例
rimo note list
rimo note list --fields id,title,created_at
rimo note list --page-size 50
rimo note list --attended --page-size 50
rimo note list --attended --page-size 50 --page-token "eyJpZCI6..."
rimo note list --today
rimo note list --week
rimo note list --team J9yyjDQLJWqhiSTH0sAT --since 2026-06-01 --until 2026-07-01
rimo note list --team J9yyjDQLJWqhiSTH0sAT --updated-since 2026-06-08出力(stdout, JSON)
{
"notes": [
{
"id": "note_abc123",
"title": "Weekly sync",
"created_at": "2026-05-12T08:30:00Z",
"owner": { "email": "alice@rimo.app" }
}
],
"next_page_token": "..."
}rimo note get
単一のノートを取得します。デフォルトのではメタデータのみが JSON 形式で出力され、追加のフラグを指定することによって文字起こしや議事録コンテンツを取得することができます。
構文
rimo note get <note_id> [flags]フラグ
| フラグ | 説明 |
|---|---|
--transcript | 文字起こしを Speaker: content 形式のプレーンテキストで出力。 |
--document | メインのドキュメントを Markdown のプレーンテキストで出力。 |
--full | 文字起こしに続けてメインのドキュメントを出力。 |
--meeting-chat | ウェブ会議(Zoom / Meet)のチャットを [HH:MM] sender: text 形式のプレーンテキストで出力。 |
--list-documents | ノートに添付されたドキュメントを一覧表示(JSON)。 |
--document-id <id> | ID で指定したドキュメントの Markdown を出力。 |
--timestamps | --transcript / --full と併用し、文字起こしの各行に [HH:MM:SS] を付与。 |
注意点
--list-documents/--document-idは--transcript/--document/--fullと 併用できません。--meeting-chatは単独の出力で、--transcript/--document/--full/--list-documents/--document-idと併用できません。--timestampsは--transcript/--fullとの併用が必須で、それ以外の組み合わせは エラーになります。指定しない場合、文字起こしの出力はこれまでと変わりません。--timestampsが表示するのは録音開始からの経過時間です([00:00:11]は開始 11 秒後)。--meeting-chatの[HH:MM]はメッセージの送信時刻(実時刻)であり、意味が異なります。各フラグ(
--transcript、--document、--full、--meeting-chat、--document-id)は stdout に JSON ではなく、プレーンテキストを出力します。
例
rimo note get note_abc123 # メタデータ JSON
rimo note get note_abc123 --transcript # プレーンテキストの文字起こし
rimo note get note_abc123 --transcript --timestamps # [HH:MM:SS] 付きの文字起こし
rimo note get note_abc123 --document # 主ドキュメントの Markdown
rimo note get note_abc123 --full # 文字起こし + ドキュメント
rimo note get note_abc123 --meeting-chat # Zoom/Meet チャットのプレーンテキスト
rimo note get note_abc123 --list-documents # ドキュメントの JSON 一覧
rimo note get note_abc123 --document-id doc_xyz # 特定ドキュメントの Markdown
rimo note get note_abc123 --fields id,title # JSON メタデータをフィルタエラー
エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。
rimo note search
意味的類似度(デフォルト)、またはキーワードと属性フィルターでノートを検索します。 rimo note list と同じ {notes, total_count} 形式の JSON を返します。一覧ではなく 統合された回答が欲しい場合は rimo note ask を使ってください。
構文
rimo note search [query] [--mode=semantic|filter] [flags]--mode=filter では query は任意です。省略すると、フィルター(チーム・期間・ 参加者・タグ)だけで開催日時の新しい順に絞り込めます。
フラグ
| フラグ | 説明 |
|---|---|
--mode | semantic(デフォルト)は意味でノートをランク付けし、filter はページネーション付きのキーワード/属性検索を行う。 |
--limit | --mode=semantic の最大結果数。 |
--page | --mode=filter のページ番号(1 始まり、デフォルト 1)。 |
--per | --mode=filter のページサイズ(デフォルト 10、最大 100)。 |
--content-type | --mode=filter を次のいずれかに限定: all transcripts headings annotations title document。 |
--team | --mode=filter 専用。1 つ以上のチームに絞り込む。繰り返しまたはカンマ区切り。チーム ID は rimo team list で取得。 |
--participant | --mode=filter 専用。指定した参加者ユーザー ID を含むノートに絞り込む。繰り返しまたはカンマ区切り。 |
--note-tag | --mode=filter 専用。指定したタグ ID を持つノートに絞り込む。繰り返しまたはカンマ区切り。 |
--since | --mode=filter 専用。この日時以降に開催されたノートのみ。YYYY-MM-DD(JST として解釈)または RFC3339 タイムスタンプ。 |
--until | --mode=filter 専用。この日時より前に開催されたノートのみ。--since と同じ形式。 |
出力
stdout に JSON {notes: [...], total_count: <int>} を出力します。Fetch a note: の ヒントは stderr に出力されるため、stdout は | jq 向けにパイプがクリーンなまま 保たれます。
{
"notes": [
{ "id": "wn9K...", "title": "Release plan: Q3 launch", "owner_name": "Alice Smith", "held_at": "2026-04-28T09:21:00Z" }
],
"total_count": 12
}フィルターモードは各結果に snippet、channel_id、owner_name、held_at、 created_at を含みます。セマンティックモードは結果ごとのメタデータが少ないため id と title のみを含みます。
例
rimo note search "release plan" # セマンティック(デフォルト)
rimo note search "release plan" --limit 5
rimo note search "release" --mode=filter --per 5 --content-type transcripts
rimo note search "release" --mode=filter --team T_abc123 # キーワード + チーム絞り込み
rimo note search --mode=filter --team T_abc --since 2026-04-01 # フィルターのみ(query 省略)
rimo note search --mode=filter --since 2026-04-01 --until 2026-07-01
rimo note search "release" --mode=filter | jq '.notes[].id'エラー
エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。
rimo note ask
自然言語で質問すると、ノートから AI が統合した回答を返します。AI による回答を生成する 唯一のコマンドです。
構文
rimo note ask <question>フラグはありません。モデルはサーバー側で固定されています。
出力(プレーンテキスト、ストリーミング)
The release is planned for Q3, with grandfathered pricing for existing
annual contracts until renewal.
Sources:
- wn9K36p46RKJKaktjDvA Pricing sync 2026-04-28
- 3K72YiEy2dEius6xpTHy Q3 planning offsite
Fetch a note:
rimo note get wn9K36p46RKJKaktjDvA --document # markdown
rimo note get wn9K36p46RKJKaktjDvA --transcript # speaker: text
rimo note get wn9K36p46RKJKaktjDvA # metadata JSON回答はモデルが生成するにつれてストリーミングされます。Sources: ブロックが正式な 引用元の表示です。
使い分け
rimo note search— 返されたノートを自分で開いて読みたいとき。rimo note ask— 回答に対する答えを引き出すために開きたいとき。
例
rimo note ask "what did we decide about Q3 pricing?"
rimo note ask "今週の議事録を要約して"エラー
エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。
rimo note create
録音を伴わない空のノートを作成します。編集用のドキュメントも同時に作成され、 マークダウンを渡すとその初期コンテンツとして取り込まれます。
notes:write スコープを持つトークンが必要です。
構文
rimo note create [markdown] [flags]初期マークダウンは位置引数か --markdown-file(- で標準入力)のどちらかで 渡します(両方は指定できません)。省略すると空のノートを作成します。複数行を そのまま渡す場合は bash/zsh の $'…' 記法(\n が改行)を使い、長い内容は --markdown-file を推奨します。
フラグ
| フラグ | 型 | デフォルト | 説明 |
|---|---|---|---|
--title | string | 自動 | ノートのタイトル(省略時は日時から自動生成) |
--team | string | "" | 作成先のチーム ID(rimo team list で取得)。省略時は個人のノート |
--locale | string | ユーザー設定 | ノートの言語設定(例: ja-JP) |
--markdown-file | string | "" | 初期マークダウンをファイルから読み込む(- で標準入力) |
例
rimo note create # 空・自動タイトルのノート
rimo note create --title "ブログ下書き"
rimo note create --title "ブログ下書き" $'# はじめに\n本文はここに。' # 複数行のマークダウン
rimo note create --markdown-file draft.md --team team_abc123
cat draft.md | rimo note create --markdown-file - --title "ブログ下書き"
rimo note create --title "ブログ下書き" --dry-run # プレビュー(作成しない)
rimo note create --title "ブログ下書き" --fields id # 新しい ID のみ出力(stdout、JSON)
{
"note": { "id": "note_abc123", "title": "ブログ下書き", "...": "..." },
"document": { "id": "doc_xyz789", "primary": true, "...": "..." }
}rimo note append はノート ID とドキュメント ID の両方を取るので、両方を 保持しておいてください。
エラー
リクエストボディが不正、locale が非対応、無効化されたチャンネルへの作成は 400、 指定したチームへの参加権限がない場合は 403 を返します。エラーの JSON 形式と終了 コードについては 出力とエラー を参照してください。
rimo note append
ノートのドキュメントにマークダウンをセクションとして取り込みます。見出し・リスト等の 構造は維持されます。既定では末尾に追記されます。
ノートの編集権限と notes:write スコープを持つトークンが必要です。
構文
rimo note append <note_id> <document_id> [markdown] [flags]マークダウンは必須で、位置引数か --markdown-file(- で標準入力)のどちらかで 渡します(両方は指定できません)。複数行をそのまま渡す場合は bash/zsh の $'…' 記法(\n が改行)を使います。ドキュメント ID は rimo note get <note_id> --list-documents で確認できます。
フラグ
| フラグ | 型 | デフォルト | 説明 |
|---|---|---|---|
--position | string | end | 挿入位置: end(末尾に追記)または start(先頭に挿入) |
--markdown-file | string | "" | マークダウンをファイルから読み込む(- で標準入力) |
例
rimo note append note_abc123 doc_xyz789 $'## ネクストアクション\n- リリースノートを公開する'
rimo note append note_abc123 doc_xyz789 --markdown-file section.md
rimo note append note_abc123 doc_xyz789 --position start "## 概要"
rimo note ask "what did we decide?" | rimo note append note_abc123 doc_xyz789 -
rimo note append note_abc123 doc_xyz789 "## メモ" --dry-run出力(stdout、JSON)
{
"document": {
"id": "doc_xyz789",
"export_markdown": "# はじめに\n\n## ネクストアクション\n\n- リリースノートを公開する",
"...": "..."
}
}export_markdown は取り込み後のドキュメントを反映するので、反映内容を確認できます。
エラー
markdown が空、--position が不正な場合は 400、編集権限がない場合は 403、 ノートまたはドキュメントが見つからない場合は 404、ロックされている場合は 409 を 返します。エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。
チーム
rimo team list
組織内のチームを一覧表示します。返されたチーム ID は rimo note list --team <id> に渡して、チームのメンバー全員のノートを一覧表示できます。
構文
rimo team list [--page-size <int>] [--page-token <string>]フラグ
| フラグ | 型 | デフォルト | 説明 |
|---|---|---|---|
--page-size | int | 0 | ページサイズ(0 の場合はサーバー側のデフォルト(現在 20)に従う) |
--page-token | string | "" | 前回の呼び出しの next_page_token から取得したカーソル |
例
rimo team list
rimo team list --page-size 5
rimo team list --page-size 5 --page-token "eyJpZCI6..."
rimo team list --fields id,name出力(stdout, JSON)
{
"teams": [
{ "id": "team_abc123", "name": "Engineering" },
{ "id": "team_def456", "name": "Design" }
],
"next_page_token": "..."
}その他
rimo version
CLI のバージョンを出力します。
構文
rimo version出力(stdout, プレーンテキスト)
rimo version 1.0.0rimo upgrade
インストール済みバイナリを最新リリースへアップグレードします。
rimo upgrade は常に最新リリースをインストールします — 古いバージョンへの固定(ピン留め)やダウングレードを行うフラグはありません。リリースアーカイブは HTTPS でダウンロードされ、実行中のバイナリを置き換える前にリリースの checksums.txt でチェックサムが検証されます。ログインは不要です。
構文
rimo upgrade [--check] [--use-sudo]フラグ
| フラグ | 説明 |
|---|---|
--check | 更新が利用可能かどうかを報告する。ダウンロードやインストールはしない。 |
--use-sudo | インストールパスが書き込み不可の場合、sudo install -m 0755 で再試行する。オプトイン。 |
出力(stdout, プレーンテキスト)
次のいずれか:
Already on the latest version (v1.0.0).
Update available: v1.0.0 → v1.1.0. Run: rimo upgrade
Upgraded rimo from v1.0.0 → v1.1.0.進捗メッセージは stderr に出力されるため、stdout をキャプチャするスクリプトには 最終的なステータス行のみが表示されます。
例
rimo upgrade --check # 新しいリリースはあるか?
rimo upgrade # 最新
sudo rimo upgrade --use-sudo # root 所有のインストールディレクトリ向けに sudo で再試行エラー
エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。
起動時の更新通知
呼び出しのたびに、ノンブロッキングのバックグラウンドバージョンチェックが実行されます。 新しいリリースが利用可能な場合、1 行が stderr に出力されます(stdout には決して 出力されません):
rimo: update available v1.0.0 → v1.1.0 (run: rimo upgrade)この通知は、バイナリがローカルの開発ビルドである場合、RIMO_NO_UPDATE_CHECK が 設定されている場合、CI が設定されている場合、または upgrade、version、--help の 呼び出しでは抑制されます。結果は 24 時間キャッシュされます。
