Skip to content

コマンド ​

すべての rimo コマンドの完全なリファレンスです。インストールについては インストール を、出力の取り決めとエラー形式については 出力とエラー を参照してください。

出力の取り決め。 すべてのコマンドはデフォルトで stdout に JSON を出力します。 人間が読みやすい表形式が欲しい場合は --pretty を付けてください。 一部の人間向けコマンドは成功時にプレーンテキストを出力します(エラーは常に JSON): rimo version、rimo upgrade、rimo note ask、--transcript / --document / --full / --meeting-chat / --document-id を指定した rimo note get、 および rimo note asset get(--json を指定しない場合は Markdown)。

以下の例は各レスポンスの形状を示すものです。すべてのフィールドについて型・説明・ 必ず含まれるかどうかを確認するには レスポンスリファレンス を参照してください。

グローバルフラグ(すべてのコマンドに適用):

フラグ説明
--account使用するアカウントのエイリアス(設定の active_account を上書き)
--fields含めるフィールド: "" (すべて)、"compact"、または "f1,f2"
--excludes出力から除外するフィールド(カンマ区切り)
--dry-run副作用なしでコマンドをシミュレーション(書き込み系のみ)
--prettyJSON の代わりに人間が読みやすい表形式で出力 — 出力とエラー を参照

認証 ​

rimo auth login ​

ブラウザベースのログインで Rimo に認証します。

構文

rimo auth login

(トップレベルの rimo login としても利用できます。)

フロー

デフォルトでは、rimo auth login はブラウザを開きます:

  1. 既定のブラウザを開き、この CLI の認可ページに遷移します。
  2. 必要に応じてサインインし、リクエストを承認するのを待機します。
  3. アクセストークンとリフレッシュトークンを OS の認証情報ストアに安全に保存します。
  4. ~/.config/rimo/config.yaml にエイリアスを登録し、アクティブに設定します。

--no-browser フロー

ブラウザが利用できない環境向け:

  1. URL を stderr に出力します。
  2. 別の端末でその URL を開き、必要に応じてサインインしてリクエストを承認します。 ページに短いコードが表示されます。
  3. プロンプトでそのコードをターミナルに貼り付けます。
  4. 上記と同様にトークンを保存し、エイリアスを登録します。

フラグ

フラグ説明
--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)

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 での 指定を求めます。

挙動

  1. 入力を正確なエイリアスに解決します(エイリアス → メール → 組織名の順)。
  2. 失効エンドポイントを呼び出します(ベストエフォート。失敗は stderr に記録されますが、 中断はしません)。
  3. OS の認証情報ストアからトークンを削除します。
  4. config.yaml からアカウントを削除します。アクティブだった場合は、アクティブ アカウントがクリアされます(自動昇格はありません)。

出力(stdout, JSON)

json
{
  "status": "logged_out",
  "alias": "alice-rimo-personal",
  "active_account": ""
}

フィールドの詳細: ログアウト結果。


rimo auth status ​

保存済みのすべてのアカウントとそのトークン状態を一覧表示します。

構文

rimo auth status

出力(stdout, JSON)

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_API_KEY または RIMO_TOKEN が設定されている場合は、active_credential (API キーの場合はあわせて api_key_hint)も返り、active_account ではなく環境変数が リクエストを認証していることを示します。

フィールドの詳細: 認証ステータス。


rimo auth switch ​

アクティブなアカウントを切り替えます。

構文

rimo auth switch <alias|email|org-name> [--org <org-name>]

rimo auth use としても利用できます。

解決の順序

  1. alias の完全一致。
  2. email の一致 — email が複数の組織に対応し、--org が指定されていない場合はエラーになります。
  3. org-name の一致。 - 現在有効なメールアドレスが所属する組織が優先されます。

フラグ

フラグ説明
--orgメールアドレスが複数の組織に登録されている場合に曖昧さを解消するための組織名。大文字・小文字と前後の空白は区別しません。それでもそのメールアドレスの複数の組織に一致する場合はエラーになり、それぞれのエイリアスを表示します。その場合はエイリアスで切り替えてください。

例

bash
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)

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 でページネーションできます。

フラグ

フラグ型デフォルト説明
--attendedboolfalse参加したノートを一覧表示
--teamstring""チームのメンバー全員のノートを一覧表示(チーム ID は rimo team list)
--todayboolfalse今日開催されたノートのショートカット(JST)。--since/--until と併用不可
--weekboolfalse直近 7 日間に開催されたノートのショートカット(JST)。--since/--until と併用不可
--sincestring""この日時以降に開催されたノートのみ(YYYY-MM-DD または RFC3339)
--untilstring""この日時より前に開催されたノートのみ(YYYY-MM-DD または RFC3339)
--updated-sincestring""この日時以降に更新されたノートのみ(YYYY-MM-DD または RFC3339)
--page-sizeint0ページサイズ(0 の場合はサーバー側のデフォルトに従う)
--page-tokenstring""前回の呼び出しの next_page_token

例

bash
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)

json
{
  "notes": [
    {
      "id": "ZJ7Rk5pSFXgBj2l4iQBV",
      "title": "Weekly sync",
      "state": "ASR_DONE",
      "duration": 584140,
      "locale": "ja-JP",
      "media_type": "audio",
      "held_at": "2026-05-12T09:00:00+09:00",
      "team_id": "J9yyjDQLJWqhiSTH0sAT",
      "share_mode": "nothing",
      "created_at": "2026-05-12T08:30:00+09:00",
      "updated_at": "2026-05-12T10:02:11+09:00"
    }
  ],
  "next_page_token": "eyJpZCI6..."
}

メタデータのみです。note list は文字起こし・ドキュメントの Markdown・タグ・ 参加者を返しません。それらが必要な場合は rimo note get にコンテンツ系 フラグを付けてください。フィールドの詳細: Note。


rimo note get ​

単一のノートを取得します。デフォルトのではメタデータのみが JSON 形式で出力され、追加のフラグを指定することによって文字起こしや議事録コンテンツを取得することができます。

構文

rimo note get <note_id> [flags]

フラグ

フラグ説明
--transcript文字起こしを Speaker: content 形式のプレーンテキストで出力。
--documentメインのドキュメントを Markdown のプレーンテキストで出力。
--full文字起こしに続けてメインのドキュメントを出力。添付ファイルはドキュメント内の配置位置に表示し、ドキュメントに配置されていない添付ファイルは最後の ## Attachments に一覧で出力。
--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 ではなく、プレーンテキストを出力します。

  • --full では、ドキュメントに配置された添付ファイルをその位置に、アセット ID を指し要約をリンクの タイトルにした形で表示します(ファイルは [report.pdf](<asset_id> "<要約>")、画像は ![photo.png](<asset_id> "<要約>")。要約がまだ無い場合はタイトルなし)。アセット ID はパスや URL ではないため、rimo note asset get <note_id> <asset_id> で読み取ります。ドキュメントに配置されて いない添付ファイル(他のドキュメントのもの、またはファイル名から 1 つの添付ファイルに特定できない 画像。画像はドキュメントに保存されたアセット ID で対応付けます。アセット ID を保存する前に保存された ドキュメントの画像はファイル名しか記録していないため、同名の画像を推測で対応付けることはせず、 その場合はセクションの先頭に > の 1 行でその旨を出力します)は、末尾の ## Attachments に添付ファイルごとに - <name> (<id>, <size>[, image]) の行と、要約がある場合は 次の行にその要約が続きます。添付ファイルのないノートの出力はこれまでと変わりません。添付ファイルの 一覧を取得できなかった場合も、ノートはそのまま出力され、stderr に warning: の行が出力されます。

例

bash
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 メタデータをフィルタ

出力 — デフォルト(stdout, JSON)

ノートのメタデータを note エンベロープで包んで返します。

json
{
  "note": {
    "id": "ZJ7Rk5pSFXgBj2l4iQBV",
    "title": "Weekly sync",
    "state": "ASR_DONE",
    "duration": 584140,
    "locale": "ja-JP",
    "media_type": "audio",
    "held_at": "2026-05-12T09:00:00+09:00",
    "team_id": "J9yyjDQLJWqhiSTH0sAT",
    "share_mode": "nothing",
    "created_at": "2026-05-12T08:30:00+09:00",
    "updated_at": "2026-05-12T10:02:11+09:00"
  }
}

フィールドの詳細: Note。

出力 — --list-documents(stdout, JSON)

json
{
  "documents": [
    {
      "id": "v9HNqz6bntLRm9BBaBEM",
      "note_id": "ZJ7Rk5pSFXgBj2l4iQBV",
      "title": "Weekly sync",
      "primary": true,
      "locale": "ja-JP",
      "category": "agenda",
      "template_mode": "minutes",
      "export_markdown": "## 決定事項\n\n- ...",
      "created_at": "2026-05-12T08:30:00+09:00",
      "updated_at": "2026-05-12T10:02:11+09:00"
    }
  ]
}

すべてのドキュメントの export_markdown が丸ごと含まれるため、レスポンスはノートの コンテンツ量に比例して大きくなります。ID とタイトルだけが必要なときは --excludes export_markdown を付けてください。フィールドの詳細: Document。

出力 — コンテンツ系フラグ(stdout, プレーンテキスト)

これらのフラグは JSON ではなくテキストを出力します。それぞれの正確な形式は Note content を参照してください。

エラー

エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。


意味的類似度(デフォルト)、またはキーワードと属性フィルターでノートを検索します。 rimo note list と同じ {notes, total_count} 形式の JSON を返します。一覧ではなく 統合された回答が欲しい場合は rimo note ask を使ってください。

構文

rimo note search [query] [--mode=semantic|filter] [flags]

--mode=filter では query は任意です。省略すると、フィルター(チーム・期間・ 参加者・タグ)だけで開催日時の新しい順に絞り込めます。

フラグ

フラグ説明
--modesemantic(デフォルト)は意味でノートをランク付けし、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)

stdout に JSON {notes: [...], total_count: <int>} を出力します。Fetch a note: の ヒント(フィルターモードではさらにページ情報と次ページ用のコマンド)は stderr に 出力されるため、stdout は | jq 向けにパイプがクリーンなまま保たれます。

json
{
  "notes": [
    {
      "id": "wn9K36p46RKJKaktjDvA",
      "title": "Release plan: Q3 launch",
      "owner_name": "Alice Smith",
      "held_at": "2026-04-28T09:21:00Z",
      "created_at": "2026-04-28T09:21:00Z",
      "snippet": {
        "transcripts": ["... the <em>release plan</em> for Q3 ..."],
        "headings": [],
        "annotations": [],
        "document_markdowns": []
      }
    }
  ],
  "total_count": 12
}

検索ヒットは完全なノートではなく、id に加えて検索インデックスが返した内容だけを 持ちます。title、held_at、created_at は取得できた場合に両モードで返り、 owner_name と snippet は --mode=filter のみです。total_count は --mode=filter では現在のページではなく結果全体の件数、--mode=semantic では 返却されたノート数です。フィールドの詳細: Search result。

例

bash
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: ブロックが正式な 引用元の表示です。3 つのブロックはいずれも stdout に出力されます。 ask の回答 を参照してください。

使い分け

  • rimo note search — 返されたノートを自分で開いて読みたいとき。
  • rimo note ask — 回答に対する答えを引き出すために開きたいとき。

例

bash
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 を推奨します。

フラグ

フラグ型デフォルト説明
--titlestring自動ノートのタイトル(省略時は日時から自動生成)
--teamstring""作成先のチーム ID(rimo team list で取得)。省略時は個人のノート
--localestringユーザー設定ノートの言語設定(例: ja-JP)
--markdown-filestring""初期マークダウンをファイルから読み込む(- で標準入力)

例

bash
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)

json
{
  "note": { "id": "note_abc123", "title": "ブログ下書き", "...": "..." },
  "document": { "id": "doc_xyz789", "primary": true, "...": "..." }
}

rimo note append はノート ID とドキュメント ID の両方を取るので、両方を 保持しておいてください。

フィールドの詳細: Note と Document。 --dry-run を付けた場合は、プレースホルダーの例に "dry_run": true を加えたものが 返ります。ドライランの出力 を参照してください。

エラー

リクエストボディが不正、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 で確認できます。

フラグ

フラグ型デフォルト説明
--positionstringend挿入位置: end(末尾に追記)または start(先頭に挿入)
--markdown-filestring""マークダウンをファイルから読み込む(- で標準入力)

例

bash
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)

json
{
  "document": {
    "id": "doc_xyz789",
    "export_markdown": "# はじめに\n\n## ネクストアクション\n\n- リリースノートを公開する",
    "...": "..."
  }
}

export_markdown は取り込み後のドキュメントを反映するので、反映内容を確認できます。 フィールドの詳細: Document。 --dry-run を付けた場合は、プレースホルダーの例に "dry_run": true を加えたものが 返り、実際の取り込み結果は分かりません。ドライランの出力 を参照してください。

エラー

markdown が空、--position が不正な場合は 400、編集権限がない場合は 403、 ノートまたはドキュメントが見つからない場合は 404、ロックされている場合は 409 を 返します。エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。

rimo note asset list ​

ノートのドキュメントが参照している添付ファイル(アップロードされたファイルや、 本文に埋め込まれた画像)の一覧を取得します。

構文

rimo note asset list <note_id> [--document-id <document_id>]

既定ではノートのすべてのドキュメントにわたる添付ファイルを一覧表示します。 --document-id を指定すると、特定のドキュメントに絞り込めます。ドキュメント ID は rimo note get <note_id> --list-documents で確認できます。

各添付ファイルには、短い要約(summary)があるかどうかを示す summary_status が 含まれます。summary は summary_status が completed のときに限り含まれます。

summary_status意味
none現時点で要約が無く、解析がまだ始まっていないこともある(アップロード直後の添付ファイルは、pending や processing に変わる前にしばらく none になることがある)。解析対象外のファイル形式や、ファイルから読み取れる内容が無かった場合、ノートの解析済み画像が上限(200件)に達していて画像の解析がスキップされた場合も none
pending解析待ち
processing解析中
completed要約がある
failed直近の解析が失敗した(自動で再試行される失敗もあるため、後で変わることがあります)

添付ファイルの解析は、現在一部の組織でのみ有効です。それ以外の組織では、すべての添付 ファイルが none になり、rimo note asset get は Not analyzed を表示します。

解析結果の全体と抽出テキストは rimo note asset get で確認できます。

フラグ

フラグ型デフォルト説明
--document-idstring""ノートの全ドキュメントではなく、このドキュメントの添付ファイルのみを一覧表示する

例

bash
rimo note asset list note_abc123
rimo note asset list note_abc123 --document-id doc_xyz789
rimo note asset list note_abc123 --fields id,name

出力(stdout、JSON)

json
{
  "assets": [
    {
      "id": "b1f0c2d4-5e6a-47b8-9c0d-1e2f3a4b5c6d",
      "name": "2026Q3_pricing.pptx",
      "mime_type": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
      "size_bytes": 4194304,
      "uploaded_at": "2026-08-06T15:04:05Z",
      "summary_status": "completed",
      "summary": "2026年第3四半期のプラン別価格改定案と移行スケジュール。"
    }
  ]
}

出力(stdout、--pretty、100 桁)

ID                                    NAME           SUMMARY STATUS  UPLOADED AT       MIME TYPE
b1f0c2d4-5e6a-47b8-9c0d-1e2f3a4b5c6d  2026Q3_prici…  completed       2026-08-06 15:04  application/…

1 asset

フィールドの詳細: Asset。

エラー

ノートへのアクセス権がない場合は 403、ノートまたはドキュメントが見つからない場合は 404 を返します。エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。

rimo note asset get ​

添付ファイル1件の詳細、解析結果(要約など)、ファイルから抽出したテキストを Markdown で表示します。

構文

rimo note asset get <note_id> <asset_id> [--json]

添付ファイル ID は rimo note asset list <note_id> で確認できます。

Markdown は、添付ファイルの詳細と解析状態を示すヘッダー、解析で得られた場合の ## Summary、そして最後に保存されている抽出テキストをそのまま (<!-- @loc page_from=… page_to=… --> のページマーカーも含めて)出力する ## Content で構成されます。

結果が完全でない場合は、内容の前の注記でその旨を示します。

状況出力される注記
添付ファイルが解析されていない(添付ファイルの解析が使えるようになる前のアップロードなど)Not analyzed — 要約・内容なし
解析待ち、または解析中Analysis pending / Analysis in progress — 時間をおいて再実行してください
解析対象外のファイル形式Not supported
ノートの解析済み画像が上限(200件)に達していたため、画像の解析がスキップされた(解析状態は skipped、エラーコードは image_limit_reached)Not analyzed — 要約・内容なし
解析に失敗したエラーコード付きの Analysis failed。失敗前に抽出したテキストがあればそれも表示
ファイルの一部しか読み取れなかったPartial coverage
画像やグラフが読み取られていないページ番号付きの Unread visuals
テキストが 1 MiB を超えるTruncated — 先頭 1 MiB と全体のサイズを表示

このコマンドは既にある解析結果を読むだけで、解析を開始・再実行することはありません。 rimo note get --full と同じく、ノート内容の1日あたりの閲覧数の上限にカウントされます。

フラグ

フラグ型デフォルト説明
--jsonboolfalseMarkdown ではなくレスポンスを JSON で出力する。--fields / --excludes / --pretty はトップレベルのキーに適用されます。

例

bash
rimo note asset get note_abc123 b1f0c2d4-5e6a-47b8-9c0d-1e2f3a4b5c6d
rimo note asset get note_abc123 b1f0c2d4-5e6a-47b8-9c0d-1e2f3a4b5c6d --json
rimo note asset get note_abc123 b1f0c2d4-5e6a-47b8-9c0d-1e2f3a4b5c6d --json --excludes content

出力(stdout、Markdown)

markdown
# 2026Q3_pricing.pdf

- ID: b1f0c2d4-5e6a-47b8-9c0d-1e2f3a4b5c6d
- Type: application/pdf
- Size: 205.9 KB
- Uploaded: 2026-08-06T15:04:05Z
- Analysis: completed
- Coverage: text
- Pages: 2
- Vision applied: no
- Document type: pricing proposal
- Language: ja

## Summary

2026年第3四半期のプラン別価格改定案と移行スケジュール。

## Content

<!-- @loc page_from=1 page_to=1 -->
## 第3四半期の価格
...

--json の場合: {asset, analysis, content, content_size_bytes, content_truncated} — AssetDetail を参照してください。

エラー

アクセス権がない場合は 403、ノートが存在しない・閲覧できない場合や、 rimo note asset list に表示されない添付ファイルの場合は 404、1日あたりの上限に 達した場合は 429 を返します。エラーは常に JSON です。形式と終了コードについては 出力とエラー を参照してください。

rimo note asset upload ​

ローカルファイルをアップロードし、ノートのドキュメントに画像またはファイルとして 挿入します。アセットレコードの作成、署名付き URL へのファイル本体のアップロード、 挿入までを 1 ステップで行います。

ノートの編集権限と notes:write スコープが必要です。

構文

rimo note asset upload <note_id> <file> [flags]

--document-id を省略すると、ノートの既定のドキュメントに挿入されます(存在しない 場合は作成されます)。--document-id を指定すると、その特定のドキュメントにのみ 挿入されます — そのドキュメントはすでに存在している必要があり、既定のドキュメント へのフォールバックは行われません(ドキュメント ID は rimo note get <note_id> --list-documents で確認できます)。

--section-title を指定しない場合、--position はドキュメントの先頭または末尾を 指します。--section-title を指定すると、その見出しのセクションに対する位置に なります: start は見出しの直後、end(既定)は配下の小見出しを含むセクションの 末尾です。一致する見出しがない場合は 404 で失敗し、ドキュメントは変更されません。

見出しのテキストは大文字・小文字を区別して完全一致で比較されます(Backend と backend は別の見出しです)。前後の空白と先頭の # は無視されます。

同じテキストの見出しが複数ある場合は、最初の見出しを基準に配置されます。アップロードは 成功し(終了コード 0、標準出力の JSON も変わりません)、標準エラー出力に次の警告が 表示されます:

text
warning: Multiple headings named "Backend" were found. The attachment was placed relative to the first matching heading.

MIME タイプは常にファイル拡張子から自動検出され、上書き用のフラグはありません。 対応形式: 画像(.jpg、.jpeg、.png、.webp)、PDF(.pdf)、Office 文書(.doc、.docx、.xls、.xlsx、.ppt、.pptx)。それ以外の拡張子、 または拡張子のないファイルは、リクエストを送る前に拒否されます。

最大ファイルサイズ: 画像は 10MB、それ以外のファイルは 100MB です。上限を超える ファイルはリクエストを送る前にローカルで拒否されます。最終的な判定はバックエンド 側の同じ上限が担います。

フラグ

フラグ型デフォルト説明
--document-idstring""ノートの既定のドキュメントではなく、このドキュメントに挿入する
--namestringファイルのベース名アセット名
--altstring""画像の代替テキスト(省略時はバックエンドがアセット名をデフォルトとして使用)
--widthint0画像の幅(ピクセル)
--heightint0画像の高さ(ピクセル)
--positionstringend挿入位置: start または end
--section-titlestring""挿入先のセクションの見出しテキスト(大文字・小文字を区別した完全一致)

例

bash
rimo note asset upload note_abc123 pricing.pptx
rimo note asset upload note_abc123 diagram.png --document-id doc_xyz789
rimo note asset upload note_abc123 report.pdf --position start
rimo note asset upload note_abc123 spec.pdf --section-title "Architecture" --position start
rimo note asset upload note_abc123 photo.jpg --alt "チーム写真" --width 1200 --height 800
rimo note asset upload note_abc123 pricing.pptx --dry-run   # create-asset リクエストのみプレビュー

出力(stdout、JSON)

json
{
  "asset": { "id": "b1f0c2d4-5e6a-47b8-9c0d-1e2f3a4b5c6d", "name": "pricing.pptx", "...": "..." },
  "document": { "id": "doc_xyz789", "primary": true, "...": "..." }
}

フィールドの詳細: Asset と Document。 --dry-run は create-asset ステップのみをシミュレートします — アップロードと挿入 ステップには実際のレスポンスから得られる署名付き URL とアセット ID が必要なため、 クライアント側でシミュレートすることはできません。プレースホルダーの例に "dry_run": true を加えたものが返ります。ドライランの出力 を参照してください。

エラー

サポート対象外のファイル形式、ファイルサイズの上限超過、不正な --position の 場合は 400、編集権限がない場合や組織でファイルアップロードが無効化されている 場合は 403、ノートが見つからない場合や --document-id がそのノートに属さない (またはアクセスできない)場合は 404、ノートまたはドキュメントがロックされて いる場合は 409 を返します。 エラーの JSON 形式と終了コードについては 出力とエラー を 参照してください。


チーム ​

rimo team list ​

組織内のチームを一覧表示します。返されたチーム ID は rimo note list --team <id> に渡して、チームのメンバー全員のノートを一覧表示できます。

構文

rimo team list [--page-size <int>] [--page-token <string>] [--include-organization]

フラグ

フラグ型デフォルト説明
--page-sizeint0ページサイズ(0 の場合はサーバー側のデフォルト(現在 20)に従う)
--page-tokenstring""前回の呼び出しの next_page_token から取得したカーソル
--include-organizationboolfalse組織自身のフォルダも返す(下記参照)

例

bash
rimo team list
rimo team list --page-size 5
rimo team list --page-size 5 --page-token "eyJpZCI6..."
rimo team list --fields id,name
rimo team list --include-organization

出力(stdout, JSON)

json
{
  "teams": [
    {
      "id": "04EFtBS4DT4pWnZV7jBU",
      "name": "Engineering",
      "category": "team",
      "is_private_channel": false,
      "member_ids": ["1F9ikNPMAMZXiVNyujFPIDKJujW2", "AZ2zlcmEGKMeD30Fn4tAiuzd3U63"],
      "parent_id": "Dt788f7DnXb6azxNJMcO",
      "created_at": "2023-11-09T04:49:09.50961Z",
      "updated_at": "2024-06-24T01:53:51.906584Z"
    }
  ],
  "next_page_token": "eyJpZCI6..."
}

チームの name は Rimo アプリ上で見えるフォルダ名です。フィールドの詳細: Team。

組織自身のフォルダ

組織にはチームフォルダとは別に、組織自身のフォルダがあります。他のフォルダと同じく ノートが保存され、その id は組織の ID です。既定では一覧に含まれません。 --include-organization を指定すると返り、"category": "organization" で チームフォルダと区別できます。

含まれるのは最初のページのみです。そのページだけ --page-size より 1 件多くなり、 2 ページ目以降は変わりません。


appointment link(アプリでは「日程調整リンク」)は、ゲストに共有する予約ページです。ゲストがブラウザで日時を選ぶと、予約が あなたのカレンダーに入ります。ここのコマンドは 自分の appointment link の読み取り・作成・変更・停止・再開・削除と、そこに入った appointment(予約)の一覧表示とキャンセルを行います(他のメンバーのリンクは表示されません)。

読み取りのコマンドは appointments:read、create・update・enable・disable・delete と appointment cancel は appointments:write スコープを持つトークンが必要です。 rimo auth login のセッションは次回のトークン更新で自動的に付与されます。スコープ追加より前に作成した 個人 API キーには付与されないため、insufficient_scope (requires …) と表示されたら新しいキーを作成して ください。appointment link は機能が有効な組織でのみ利用でき、それ以外の組織ではいずれのコマンドも API error 403: appointment links are not available for this organization を返します。判定はログイン時に選んだ 組織で行われるため、複数の組織に所属している場合は rimo auth switch で切り替えてください。

自分の appointment link を、作成日時の新しい順に一覧表示します。無効化したリンクと受付を終了したリンクも 含まれます。

構文

rimo appointment link list

例

bash
rimo appointment link list
rimo appointment link list --fields id,title,url
rimo appointment link list --pretty

出力(stdout, JSON)

json
{
  "appointment_links": [
    {
      "id": "J9yyjDQLJWqhiSTH0sAT",
      "url": "https://rimo.app/appointment/guest/J9yyjDQLJWqhiSTH0sAT",
      "edit_url": "https://rimo.app/appointment/J9yyjDQLJWqhiSTH0sAT/edit",
      "title": "30分ミーティング",
      "duration_minutes": 30,
      "disabled": false,
      "closed": false,
      "single_use": false,
      "calendar_provider": "google",
      "meeting_providers": ["google_meet"],
      "participants": [
        { "user_id": "AZ2zlcmEGKMeD30Fn4tAiuzd3U63", "name": "山田 太郎", "email": "taro@example.com" }
      ],
      "created_at": "2026-09-01T00:00:00Z",
      "updated_at": "2026-09-02T00:00:00Z"
    }
  ]
}

url はゲストに共有する予約ページです。フィールドの説明: Appointment link。リンクのすべての設定は get <id> で確認できます。

自分の appointment link(日程調整リンク)を 1 件、すべての設定とともに表示します。list が出力する項目に加えて、 受付時間・タイムゾーン・受付期間・最短予約時間・前後の確保時間・候補の刻み幅・キャンセル期限・キーワード・ 祝日・日付指定の受付調整・通知の設定が含まれます。他のユーザーのリンクは、存在しないリンクと同じく not found になります。

出力のフィールド名は create -f と update -f の ファイルと同じなので、そのまま元ファイルとして使えます。保存して編集し、渡し直すとリンクをコピー(create) または変更(update)できます。

構文

rimo appointment link get <link-id>

例

bash
rimo appointment link get J9yyjDQLJWqhiSTH0sAT
rimo appointment link get J9yyjDQLJWqhiSTH0sAT --fields availability_rules,time_zone
rimo appointment link get J9yyjDQLJWqhiSTH0sAT > link.json
rimo appointment link get J9yyjDQLJWqhiSTH0sAT --pretty

出力(stdout, JSON)

json
{
  "appointment_link": {
    "id": "J9yyjDQLJWqhiSTH0sAT",
    "url": "https://rimo.app/appointment/guest/J9yyjDQLJWqhiSTH0sAT",
    "edit_url": "https://rimo.app/appointment/J9yyjDQLJWqhiSTH0sAT/edit",
    "title": "30分ミーティング",
    "description": "ご都合の良い日時をお選びください。",
    "duration_minutes": 30,
    "disabled": false,
    "closed": false,
    "single_use": false,
    "calendar_provider": "google",
    "meeting_providers": ["google_meet"],
    "participants": [
      { "user_id": "AZ2zlcmEGKMeD30Fn4tAiuzd3U63", "name": "山田 太郎", "email": "taro@example.com" }
    ],
    "availability_rules": [
      { "weekday": 1, "start_time": "10:00", "end_time": "18:00" },
      { "weekday": 2, "start_time": "10:00", "end_time": "18:00" }
    ],
    "time_zone": "Asia/Tokyo",
    "days_in_advance": 14,
    "closes_on": "",
    "min_notice_hours": 24,
    "buffer_before_minutes": 0,
    "buffer_after_minutes": 0,
    "appointment_slot_interval_minutes": 0,
    "cancellation_deadline_hours": 0,
    "auto_reserve_recording": true,
    "disable_appointment_confirmed_email": false,
    "share_note_with_guest": false,
    "include_keywords": [],
    "include_keywords_only": false,
    "exclude_keywords": [],
    "holiday_countries": ["JP"],
    "time_overrides": [
      { "type": "block", "start_date": "2026-12-29", "end_date": "2027-01-03", "start_time": "00:00", "end_time": "23:59", "note": "年末年始" }
    ],
    "poll_enabled": false,
    "created_at": "2026-09-01T00:00:00Z",
    "updated_at": "2026-09-02T00:00:00Z"
  }
}

フィールドの説明: Appointment link detail。

エラー

エラーcode終了コード
リンクが存在しない、または他のユーザーのリンクnot_found3
appointments:read が無い(details.required_scopes に必要なスコープが入ります)permission_denied2
組織で機能が有効でないfeature_unavailable2
ID が無い、または 2 つ以上あるvalidation_error4

エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。

自分の appointment link(日程調整リンク)を作成します。レスポンスはすべての設定を含む新しいリンクで、 その url がゲストに共有する予約ページです。

必須なのはタイトルだけです。指定しなかった項目は Rimo アプリの個人設定、無ければ ファイルのキー の表にあるシステムのデフォルト値で補われるため、--title だけで作った リンクもアプリで作ったリンクと同じように予約を受け付けます。CLI 側では何も補いません。送るのは 指定したフラグとファイルのキーだけです。

appointments:write スコープが必要です。rimo auth login のセッションは次回のトークン更新で自動的に 付与されます。スコープ追加より前に作成した個人 API キーには付与されないため、 insufficient_scope (requires appointments:write) と表示されたら新しいキーを作成してください。

構文

rimo appointment link create --title <title> [flags]
rimo appointment link create -f <file.json> [flags]

まず --dry-run で実行してください。サーバーが実際の作成とまったく同じ補完と検証を行い、保存せずに 最終的なリンクを返すため、作成する前に補われた設定をすべて確認できます。dry run のリンクにはまだ id、url、edit_url がありません("" です)。共有する url は実際の作成で得られます。

フラグ

フラグボディの項目説明
--titletitleリンクのタイトル。ファイルに title が無い場合は必須
--descriptiondescription予約ページでゲストに表示する説明
--durationduration_minutes打合せ時間(分)
--daysavailability_rules予約を受け付ける曜日。曜日名(sun mon tue wed thu fri sat、または完全な英語名。大文字・小文字は問いません)、リスト(mon,wed)、範囲(mon-fri、sat-sun)で指定します。数字と、週の終わりをまたぐ範囲(fri-mon)は受け付けません。--hours が必要です
--hoursavailability_rules--days の各曜日に受け付ける時間帯(HH:MM-HH:MM)。1 日に複数の時間帯を設定するときは繰り返し指定します。--days が必要です
--time-zonetime_zone時間帯を解釈する IANA のタイムゾーン(例: Asia/Tokyo)
--calendarcalendar_providergoogle または outlook
--meetingmeeting_providers会議ツール。指定した順に試します: meet、zoom、teams(google_meet、microsoft_teams も可)。繰り返し指定またはカンマ区切り
--no-meetingmeeting_providers会議 URL を発行しない([] を送ります)
--co-hostsparticipants一緒にホストを務める組織内のメンバー。メールアドレスまたはユーザー ID を、カンマ区切りまたは繰り返しで指定します。@ を含む値はメールアドレスとして扱います
--single-usesingle_use最初の 1 件の予約で受付を終了する
--auto-record / --no-auto-recordauto_reserve_recordingリンクから予約された会議を自動で録画するかどうか。リンクの保存後に入った予約に適用されます
--closes-oncloses_on受付を終了する日(YYYY-MM-DD)
-f, --fileボディ全体リンクの設定を書いた JSON ファイル。- で標準入力から読み込みます

--days mon-fri --hours 10:00-12:00 --hours 13:00-17:00 は曜日と時間帯の組ごとに 1 つのルール(計 10 個) を作ります。曜日ごとに時間帯を変えるときは、ファイルの availability_rules を使ってください。

co-host(同席者)は、カレンダーの空きも確認される組織内のメンバーです。ゲストではありません。ゲストは リンクの url から予約します。

フラグはファイルの同じキーより優先されます。--days/--hours とファイルの availability_rules は同時に 指定できません。また --meeting と --no-meeting、--auto-record と --no-auto-record は矛盾するため、 いずれもリクエストを送る前にエラーになります。

ファイルのキー ​

ファイルは 1 つの JSON オブジェクトで、get が出力するのと同じフィールド名を 使います。get(または create --dry-run)の出力はそのまま渡せます。{"appointment_link": {...}} の形を受け付け (appointment_link と並ぶ warnings と dry_run は無視し、それ以外のキーがそこにあると unknown_field でエラーになります)、 読み取り専用のキー id、url、edit_url、closed、created_at、updated_at は無視し、 disabled と poll_enabled は false のときだけ無視し、co-host は user_id で送ります。リンクのオブジェクト自体 (そのままのオブジェクト、または appointment_link の内側)にある warnings と dry_run は設定ではないため unknown_field でエラーになります。誤って入った "dry_run": true が実際の作成にならないためです。ドライランには --dry-run を使ってください。create は無効化した リンクやグループ投票のリンクを作れないため、"disabled": true や "poll_enabled": true を含むリンクをコピーすると unknown_field でエラーになります。そのキーを false にするか削除してください。それ以外のサーバーが知らないキーも unknown_field でエラーになります。

デフォルト値は、キーを省略し、個人設定でも設定されていない場合に使われます。

キー型 / 値デフォルト
title文字列—(必須)
description文字列""
duration_minutes整数、5〜72030
availability_rules{"weekday": 0〜6(0 = 日曜日), "start_time": "HH:MM", "end_time": "HH:MM"} の配列月〜金 09:00〜18:00
time_zoneIANA 名Asia/Tokyo
days_in_advance整数、1〜365: 何日先まで予約を受け付けるか14
closes_on"YYYY-MM-DD"(受付最終日)または ""(期限なし)""
min_notice_hours整数、0〜72024
buffer_before_minutes整数、0〜7200
buffer_after_minutes整数、0〜7200
appointment_slot_interval_minutes整数、0〜720。0 は打合せ時間と同じ0
single_use真偽値false
auto_reserve_recording真偽値true
cancellation_deadline_hours整数、0〜720。0 は開始直前まで0
calendar_provider"google" | "outlook"連携済みのカレンダー(両方連携済みなら google)
meeting_providers"google_meet" | "zoom" | "microsoft_teams" の配列(優先順)。[] は会議 URL なしGoogle なら google_meet、Outlook なら microsoft_teams
participantsco-host: {"user_id": "..."} または {"email": "..."} の配列。両方ある場合は user_id を使います[]
include_keywords文字列の配列[]
include_keywords_only真偽値。include_keywords が必要false
exclude_keywords文字列の配列[]
holiday_countriesISO の国コードの配列(例: ["JP"])。Google カレンダーのみ個人設定が無ければ []。個人設定はあるが祝日を設定していなければ ["JP"]
time_overrides{"type": "block" | "open", "start_date", "end_date": "YYYY-MM-DD", "start_time", "end_time": "HH:MM", "note"} の配列[]
disable_appointment_confirmed_email真偽値false
share_note_with_guest真偽値false

すべてのキーを書いたファイルの例:

json
{
  "title": "初回ヒアリング",
  "description": "まずは 45 分ほどお話ししましょう。",
  "duration_minutes": 45,
  "availability_rules": [
    { "weekday": 1, "start_time": "10:00", "end_time": "12:00" },
    { "weekday": 3, "start_time": "13:00", "end_time": "17:00" }
  ],
  "time_zone": "Asia/Tokyo",
  "days_in_advance": 30,
  "closes_on": "2026-12-31",
  "min_notice_hours": 12,
  "buffer_before_minutes": 10,
  "buffer_after_minutes": 10,
  "appointment_slot_interval_minutes": 30,
  "single_use": false,
  "auto_reserve_recording": true,
  "cancellation_deadline_hours": 24,
  "calendar_provider": "google",
  "meeting_providers": ["google_meet"],
  "participants": [{ "email": "cohost@example.com" }],
  "include_keywords": ["focus"],
  "include_keywords_only": false,
  "exclude_keywords": ["private"],
  "holiday_countries": ["JP"],
  "time_overrides": [
    { "type": "block", "start_date": "2026-12-29", "end_date": "2027-01-03", "start_time": "00:00", "end_time": "23:59", "note": "年末年始" }
  ],
  "disable_appointment_confirmed_email": false,
  "share_note_with_guest": false
}

例

bash
rimo appointment link create --title "初回ヒアリング" --dry-run    # 補われた設定を確認するだけで作成しない
rimo appointment link create --title "初回ヒアリング"
rimo appointment link create --title "初回ヒアリング" --duration 45 --days mon-fri --hours 10:00-12:00 --hours 13:00-17:00 --time-zone Asia/Tokyo --calendar outlook --meeting teams --co-hosts alice@example.com --single-use
rimo appointment link create -f link.json
rimo appointment link get J9yyjDQLJWqhiSTH0sAT | rimo appointment link create -f - --title "コピー"
rimo appointment link create --title "初回ヒアリング" --fields url  # 共有する URL だけ

出力(stdout、JSON)

json
{
  "appointment_link": {
    "id": "Kq3pX9vB2mLwT7yZ1cDe",
    "url": "https://rimo.app/appointment/guest/Kq3pX9vB2mLwT7yZ1cDe",
    "edit_url": "https://rimo.app/appointment/Kq3pX9vB2mLwT7yZ1cDe/edit",
    "title": "初回ヒアリング",
    "duration_minutes": 30,
    "...": "get と同じすべての設定"
  },
  "warnings": [
    { "code": "meeting_provider_unavailable", "field": "meeting_providers[0]", "message": "Zoom is not connected; bookings will use microsoft_teams" }
  ],
  "dry_run": false
}

appointment_link は get と同じフィールドを持ちます(フィールドの説明: Appointment link detail)。warnings は、リンクの作成は止めないものの 知っておくべき点の一覧で、それぞれ stderr にも warning: … の 1 行として出力されます。--dry-run の場合は リンクを保存せず、dry_run が true になり、id、url、edit_url は "" になります。--fields と --excludes は リンクに適用されます。

network_error で失敗した場合は、リンクが作成されたかどうか分かりません。もう一度実行する前に rimo appointment link list で確認してください。

エラー

エラーcode終了コード
サーバーが知らないキーがある(details に誤ったキーすべて・近いキーの候補・指定できるキーが入ります)unknown_field4
JSON の形式や値の型が不正invalid_request4
値が範囲外・形式不正(details[].field が該当箇所のパス)invalid_field4
予約できる時間が 1 つも生まれない設定no_bookable_window4
カレンダーが連携されていないhost_calendar_not_connected4
カレンダーに予定を書き込む権限が無いhost_calendar_write_scope_missing4
co-host が組織のメンバーではないparticipant_not_found4
co-host のカレンダーが連携されていないparticipant_calendar_not_connected4
どの会議ツールも会議 URL を発行できない(発行しない場合は --no-meeting)no_meeting_provider_available4
タイトルが無い、フラグが矛盾している、--days/--hours が不正、ファイルが 1 つの JSON オブジェクトではない(送信前に確認)validation_error4
-f のファイルを読み込めない(送信前に確認)validation_error4
appointments:write が無い(details.required_scopes に必要なスコープが入ります)permission_denied2
組織で機能が有効でないfeature_unavailable2
リクエストボディが大きすぎるrequest_too_large1

エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。

自分の appointment link(日程調整リンク)の設定を変更します。変わるのは指定したもの(設定したフラグと ファイルのキー)だけで、それ以外の設定は今の値のままです。レスポンスは変更後のリンク全体です。

create と違い、個人設定やデフォルト値では何も補いません。サーバーは変更後のリンクを create と同じ規則で 検証するため、予約できる時間が生まれなくなる変更や、連携していないカレンダー・会議ツールを指定する変更は エラーになります。送った値が書き換えられることはありません。Google Meet を使うリンクを --calendar outlook に変えるときは、--meeting(または --no-meeting)も指定しないとエラーになります。

appointments:write スコープが必要です(create を参照)。

構文

rimo appointment link update <link-id> [flags]
rimo appointment link update <link-id> -f <file.json> [flags]

まず --dry-run で実行してください。サーバーが実際の変更とまったく同じ検証を行い、保存せずに変更後の リンクを返します。

フラグ

create と同じフラグに --no-co-hosts が加わります。必須のフラグはありませんが、 フラグかファイルのキーを少なくとも 1 つ指定する必要があります。

フラグボディの項目説明
--titletitle新しいタイトル
--descriptiondescriptionゲストに表示する説明。--description "" で消します
--durationduration_minutes打合せ時間(分)
--days + --hoursavailability_rules受付時間のルールを すべて 置き換えます(書き方は create と同じ)
--time-zonetime_zoneIANA のタイムゾーン
--calendarcalendar_providergoogle または outlook。今の会議ツールが新しいカレンダーで使えない場合は --meeting も指定します
--meetingmeeting_providers会議ツールを置き換えます。指定した順に試します
--no-meetingmeeting_providers会議 URL を発行しない([] を送ります)
--co-hostsparticipantsco-host の一覧を 丸ごと 置き換えます。残したい co-host もすべて指定してください
--no-co-hostsparticipantsco-host をすべて外します([] を送ります)
--single-usesingle_use最初の 1 件の予約で受付を終了する。--single-use=false で解除します
--auto-record / --no-auto-recordauto_reserve_recordingこれから入る予約の会議を自動で録画するかどうか
--closes-oncloses_on受付を終了する日(YYYY-MM-DD)。--closes-on "" で期限を無くします
-f, --file変更するキーJSON ファイル。- で標準入力から読み込みます

変更の適用のされ方

  • 省略したキーと、ファイルで null にしたキーは今の値のままです。
  • 一覧は丸ごと置き換えます: availability_rules、participants、meeting_providers、include_keywords、 exclude_keywords、holiday_countries、time_overrides。「1 件だけ追加」はできないため、最終的な一覧をすべて 送ってください。
  • "" で文字列(description、closes_on)を消し、[] で一覧を空にします。title、time_zone、calendar_provider、 availability_rules は空にできません(400 invalid_field)。
  • 日付に関する検証(closes_on が過去でないこと、min_notice_hours が受付期間に収まること)は、リクエストで closes_on、min_notice_hours、time_zone のどれかを保存済みと違う値に変えたときだけ行います(closes_on はリンクのタイムゾーンでの日付です)。受付最終日を過ぎたリンクでも、 名前の変更や期限の削除はできます。
  • カレンダー・co-host・会議ツールの確認は、calendar_provider、participants、meeting_providers を変えたときだけ 行います。保存済みと同じ値は変更とみなしません(co-host は同じ人を同じ順に user_id で指定した場合)。

ファイルには create のファイルのキー を使います(デフォルト値は適用されません)。 get の出力はそのまま渡せます。{"appointment_link": {...}} の形を受け付け (appointment_link と並ぶ warnings と dry_run は無視します)、 読み取り専用のキー(id、url、edit_url、closed、created_at、updated_at)と disabled は無視し(変更でリンクの受付を停止・再開することはありません。disable と enable を使います)、poll_enabled は値にかかわらず無視し(グループ投票のリンク自体は poll_link_not_supported で拒否します)、co-host は user_id で送ります。create と同じく、リンクのオブジェクト自体にある warnings と dry_run は unknown_field でエラーになるため、誤って入った "dry_run": true が実際の更新になることはありません。 ドライランには --dry-run を使ってください。保存済みと同じ値は変更とみなさないため、 受付最終日を過ぎたリンクもそのまま戻せます。それでも、できるだけ変更するキーだけを送ってください。フラグはファイルの同じキーより 優先されます。ただし --days/--hours とファイルの availability_rules は同時に指定できません。

例

bash
rimo appointment link update J9yyjDQLJWqhiSTH0sAT --duration 60 --dry-run    # まず確認する
rimo appointment link update J9yyjDQLJWqhiSTH0sAT --duration 60
rimo appointment link update J9yyjDQLJWqhiSTH0sAT --days mon-thu --hours 10:00-17:00   # ルールをすべて置き換える
rimo appointment link update J9yyjDQLJWqhiSTH0sAT --calendar outlook --meeting teams
rimo appointment link update J9yyjDQLJWqhiSTH0sAT --co-hosts alice@example.com,bob@example.com
rimo appointment link update J9yyjDQLJWqhiSTH0sAT --no-co-hosts
rimo appointment link update J9yyjDQLJWqhiSTH0sAT --closes-on ""                # 期限なし
echo '{"buffer_before_minutes": 10}' | rimo appointment link update J9yyjDQLJWqhiSTH0sAT -f -
rimo appointment link get J9yyjDQLJWqhiSTH0sAT > link.json   # link.json を編集してから:
rimo appointment link update J9yyjDQLJWqhiSTH0sAT -f link.json

出力(stdout、JSON)

create と同じ {appointment_link, warnings, dry_run} の形です。 appointment_link は変更後のリンク全体で、警告はそれぞれ stderr にも出力され、--fields / --excludes は リンクに適用されます。--dry-run の場合は何も保存せず、dry_run が true になります。変更は値を足すのではなく 設定するため、network_error の後にもう一度実行しても問題ありません。

エラー

エラーcode終了コード
変更するものが無い: フラグもファイルのキーも無い(送信前に確認)validation_error4
フラグが矛盾している(--co-hosts と --no-co-hosts など)、--days/--hours が不正、ID が無い、ファイルが 1 つの JSON オブジェクトではない(送信前に確認)validation_error4
null の値と無視するキーを除くと、変更するものが残らないempty_update4
グループ投票のリンク(Rimo の Web アプリで管理します)poll_link_not_supported4
サーバーが知らないキーがあるunknown_field4
JSON の形式や値の型が不正invalid_request4
値が範囲外・形式不正、または組み合わせが使えない(例: Outlook で Google Meet)。details[].field が該当箇所のパスinvalid_field4
変更後のリンクで予約できる時間が 1 つも生まれないno_bookable_window4
host_calendar_not_connected、host_calendar_write_scope_missing、participant_not_found、participant_calendar_not_connected、no_meeting_provider_availablecreate と同じ4
単発リンクが予約済みで受付を終了している(新しいリンクを作成してください)link_closed1
リンクが存在しない、または他のユーザーのリンクnot_found3
-f のファイルを読み込めない(送信前に確認)validation_error4
appointments:write が無い(details.required_scopes に必要なスコープが入ります)permission_denied2
組織で機能が有効でないfeature_unavailable2
リクエストボディが大きすぎるrequest_too_large1

エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。

自分の appointment link で新しい予約の受付を停止します。リンク・設定・URL は残り、そのリンクですでに入った 予約も残ります(カレンダーの予定と会議 URL はそのままで、rimo appointment list にも表示されます)。URL を開いたゲストは予約できなくなります。受付の再開は enable で行います。

すでに停止中のリンクを停止しても成功し、何も変わりません。appointments:write スコープが必要です。

停止ではリンクの設定やカレンダー・会議ツールの連携を確認しないため、今の設定では予約できないリンク(たとえば Rimo の アプリで、API では受け付けない組み合わせで作ったリンク)も停止できます。これらは enable で再開するときにすべて確認し直します。

構文

rimo appointment link disable <link-id>

グローバルフラグ以外のフラグはありません。--dry-run を付けるとサーバーが実際の変更と同じように応答し、 保存せずに保存後のリンクを返します。

例

bash
rimo appointment link disable J9yyjDQLJWqhiSTH0sAT --dry-run   # まず確認する
rimo appointment link disable J9yyjDQLJWqhiSTH0sAT
rimo appointment list J9yyjDQLJWqhiSTH0sAT                     # 入っている予約は残る

出力(stdout、JSON)

update と同じ {appointment_link, warnings, dry_run} の形で、リンクの "disabled" は true です。network_error の後にもう一度実行しても問題ありません。

エラー

エラーcode終了コード
ID が無い、複数ある、または空(送信前に確認)validation_error4
グループ投票のリンク(Rimo の Web アプリで管理します)poll_link_not_supported4
単発リンクが予約済みで受付を終了しているlink_closed1
リンクが存在しない、または他のユーザーのリンクnot_found3
appointments:write が無い(details.required_scopes に必要なスコープが入ります)permission_denied2
組織で機能が有効でないfeature_unavailable2

disable や Rimo のアプリで停止したリンクの受付を再開します。リンクの設定と URL は そのままです。

停止中に状況が変わっている可能性があるため、サーバーは再開の前に create と 同じ規則でリンクを検証し直します。

  • 自分のカレンダーが連携済みで、予定を追加する権限があること
  • すべての co-host が組織の有効なメンバーのままで、Rimo が読めるカレンダーがあること
  • 会議ツールのどれかが会議 URL を発行できること(会議 URL を発行しないリンクを除く)
  • 設定の組み合わせが使え、ゲストが予約できる時間が生まれること(update と同じ規則で、予約の長さが受付時間に収まる、 min_notice_hours が受付期間より短い、ブロックの例外設定がすべての時間帯を塞いでいない、を確認します)

終了日(closes_on)が過ぎているかは確認しません。リンクは再開されますが、update --closes-on YYYY-MM-DD で終了日を 延ばすか update --closes-on "" で終了日を外すまで、ゲストは予約できません。

満たさない場合、リンクは停止したままで、エラーに直し方が示されます。Rimo のアプリか update で直してから、もう一度実行してください。受付中のリンクを再開しても 何も変わりません。appointments:write スコープが必要です。

構文

rimo appointment link enable <link-id>

グローバルフラグ以外のフラグはありません。まず --dry-run で実行してください。サーバーが同じ検証を行い、 保存せずに保存後のリンクを返します。

例

bash
rimo appointment link enable J9yyjDQLJWqhiSTH0sAT --dry-run   # 再開できるか確認する
rimo appointment link enable J9yyjDQLJWqhiSTH0sAT
rimo appointment link enable J9yyjDQLJWqhiSTH0sAT --fields id,disabled,url

出力(stdout、JSON)

update と同じ {appointment_link, warnings, dry_run} の形で、リンクの "disabled" は false です。警告(たとえば、ほかの会議ツールは使えるが一部の会議ツールが会議 URL を発行できない)は stderr にも出力されます。network_error の後にもう一度実行しても問題ありません。

エラー

エラーcode終了コード
ID が無い、複数ある、または空(送信前に確認)validation_error4
カレンダーの連携が外れている、または Outlook に予定を追加する権限が無いhost_calendar_not_connected、host_calendar_write_scope_missing4
co-host が組織の有効なメンバーではなくなっている(update --co-hosts で外してください)participant_not_found4
co-host のカレンダーを Rimo が読めなくなっているparticipant_calendar_not_connected4
リンクの会議ツールのどれも会議 URL を発行できないno_meeting_provider_available4
リンクの設定で予約できる時間が生まれない、または設定の組み合わせが使えない。details[].field が該当箇所のパスno_bookable_window、invalid_field4
グループ投票のリンク(Rimo の Web アプリで管理します)poll_link_not_supported4
単発リンクが予約済みで受付を終了している(新しいリンクを作成してください)link_closed1
リンクが存在しない、または他のユーザーのリンクnot_found3
appointments:write が無い(details.required_scopes に必要なスコープが入ります)permission_denied2
組織で機能が有効でないfeature_unavailable2

エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。

自分の appointment link を削除します。URL はすぐに使えなくなり、リンクは元に戻せません。新しい予約の受付を止めるだけで リンクを残したい場合は、代わりに disable を使ってください。リンク・URL・予約が残り、 enable で元に戻せます。

リンクを削除しても、そのリンクで入った予約はキャンセルされません(カレンダーの予定・会議 URL・録画の予約は残ります)。 ただし、リンクを削除すると、その予約は Rimo から一覧もキャンセルもできなくなり、ゲストのキャンセルページも 使えなくなります(ゲストへの議事録の自動共有も行われなくなります)。そのため、リンクに 今後の予約(確定済みで開始時刻が現在以降のもの)があるあいだは、 サーバーが link_has_upcoming_appointments で削除を拒否し、何も削除しません。エラーの details に今後の予約が開始の早い順に最大 10 件入ります(件数はメッセージに入ります。すべては rimo appointment list <link-id> で確認できます)。 先に rimo appointment cancel <appointment-id>(details の各 id)で予約をキャンセルしてからもう一度削除するか、--keep-appointments を付けて実行し直して、 予約を残したままリンクを削除してください。過去の予約やキャンセル済みの予約は削除を妨げません。

グループ投票のリンクも削除できます(集めた回答も削除されます)。appointments:write スコープが必要です。

構文

rimo appointment link delete <link-id> [--keep-appointments]

フラグ

フラグ型デフォルト説明
--keep-appointmentsboolfalse今後の予約があっても削除します。予約は残りますが、Rimo から一覧もキャンセルもできなくなり、ゲストへの議事録の自動共有も行われなくなります

--dry-run を付けるとサーバーが同じ確認(今後の予約の確認を含む)を行い、削除せずに応答します。確認の プロンプトはありません。今後の予約の確認はサーバーが行います。

例

bash
rimo appointment link delete J9yyjDQLJWqhiSTH0sAT --dry-run              # まず確認する
rimo appointment link delete J9yyjDQLJWqhiSTH0sAT
rimo appointment link delete J9yyjDQLJWqhiSTH0sAT --keep-appointments    # 今後の予約を残して削除する
rimo appointment link disable J9yyjDQLJWqhiSTH0sAT                       # 新しい予約を止めるだけにする

出力(stdout、JSON)

json
{
  "appointment_link_id": "J9yyjDQLJWqhiSTH0sAT",
  "deleted": true,
  "dry_run": false,
  "upcoming_appointments": 2,
  "warnings": [
    {
      "code": "link_had_upcoming_appointments",
      "message": "2 upcoming appointments were kept; they can no longer be listed or cancelled through Rimo."
    }
  ]
}

upcoming_appointments はリンクにあった今後の予約の件数で、0 より大きくなるのは --keep-appointments を付けた場合だけです。 その場合は link_had_upcoming_appointments の警告も入ります(stderr にも出力されます)。--dry-run では deleted が false、dry_run が true です。--fields と --excludes はこれらのキーに適用されます。各フィールドの説明は Appointment link の削除結果 を参照してください。

network_error の後は、リンクが削除されたかどうか分かりません。rimo appointment link get <link-id> で確認してください (not_found なら削除済みです)。

エラー

エラーcode終了コード
ID が無い、複数ある、または空(送信前に確認)validation_error4
リンクに今後の予約があり、--keep-appointments を付けていない。details[] に開始の早い順に最大 10 件の id・start_at・guest_name が入り、件数はメッセージに入ります。何も削除しませんlink_has_upcoming_appointments1
リンクが存在しない、または他のユーザーのリンクnot_found3
appointments:write が無い(details.required_scopes に必要なスコープが入ります)permission_denied2
組織で機能が有効でないfeature_unavailable2
json
{
  "code": "link_has_upcoming_appointments",
  "details": [
    {
      "guest_name": "Hanako Sato",
      "id": "J9yyjDQLJWqhiSTH0sAT-1791248400",
      "start_at": "2026-10-20T01:00:00Z"
    }
  ],
  "message": "API error 409: This appointment link has 1 upcoming appointment. Deleting the link keeps it, but it can no longer be listed or cancelled through Rimo (also not from the guest's cancel page). Cancel it first with POST /appointments/APPOINTMENT_ID/cancel (rimo appointment cancel APPOINTMENT_ID), or retry with keep_appointments=true (--keep-appointments) to delete the link anyway."
}

エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。

rimo appointment list ​

自分の appointment link に入った確定済みの appointment を、開始日時の早い順に一覧表示します。 過去の appointment も含まれ、キャンセル済みのものは含まれません。

構文

rimo appointment list <link-id>

<link-id> はリンクの id で、rimo appointment link list で確認できます。

例

bash
rimo appointment list J9yyjDQLJWqhiSTH0sAT
rimo appointment list J9yyjDQLJWqhiSTH0sAT --fields start_at,guest_name,meeting_url
rimo appointment list J9yyjDQLJWqhiSTH0sAT --pretty

出力(stdout, JSON)

json
{
  "appointments": [
    {
      "id": "J9yyjDQLJWqhiSTH0sAT-1791248400",
      "appointment_link_id": "J9yyjDQLJWqhiSTH0sAT",
      "status": "confirmed",
      "start_at": "2026-10-05T01:00:00Z",
      "end_at": "2026-10-05T01:30:00Z",
      "guest_name": "佐藤 花子",
      "guest_email": "hanako@example.com",
      "guest_message": "よろしくお願いします。",
      "guest_participants": [],
      "meeting_url": "https://zoom.us/j/123456789",
      "meeting_provider": "zoom",
      "calendar_provider": "google",
      "cancelled_at": null,
      "created_at": "2026-10-01T00:00:00Z"
    }
  ]
}

一覧の appointment はすべて status が confirmed、cancelled_at が null です。 自分のものではないリンクは、存在しないリンクと同じく「見つからない」として扱われます。 フィールドの説明: Appointment。

rimo appointment cancel ​

自分の appointment link に入った appointment を 1 件キャンセルします。Rimo のアプリでキャンセルした場合と 同じ処理を行います。

  • カレンダーから予定を削除し、カレンダーがゲストにキャンセルを通知します(Google カレンダーは参加者全員に 通知します)。予定を削除できなかった場合は何もキャンセルせず、calendar_event_delete_failed で失敗します。 Rimo でカレンダーを連携し直してから(メッセージに設定画面の URL が入ります)、もう一度実行してください。
  • 会議の録画の予約(録画ボット)を解除します。
  • appointment のために発行した Zoom の会議を削除します。Microsoft Teams の会議は削除しません。
  • Rimo からキャンセルのメールは送りません。

キャンセルは 元に戻せません。ゲストに予約し直してもらう必要があります。過去の appointment やグループ投票の リンクの appointment もキャンセルできます。appointments:write スコープが必要です。

appointment の ID だけで指定できます(リンクの ID は不要です)。ID は rimo appointment list <link-id> の各 appointment の id で確認できます。 キャンセルした appointment はそこに表示されなくなります。

構文

rimo appointment cancel <appointment-id>

--dry-run を付けるとサーバーが確認(appointment が存在し、自分のもので、キャンセル済みでないこと)を行い、 キャンセルせずに現在の appointment を "dry_run": true 付きで返します。カレンダーの予定は 確認しない ため、 ドライランが通っても実際のキャンセルが calendar_event_delete_failed で失敗することがあります。確認のプロンプトはありません。

例

bash
rimo appointment list J9yyjDQLJWqhiSTH0sAT --fields id,start_at,guest_name   # ID を確認する
rimo appointment cancel J9yyjDQLJWqhiSTH0sAT-1791248400 --dry-run                  # まず確認する
rimo appointment cancel J9yyjDQLJWqhiSTH0sAT-1791248400
rimo appointment cancel J9yyjDQLJWqhiSTH0sAT-1791248400 --fields id,status,cancelled_at

出力(stdout、JSON)

json
{
  "appointment": {
    "id": "J9yyjDQLJWqhiSTH0sAT-1791248400",
    "appointment_link_id": "J9yyjDQLJWqhiSTH0sAT",
    "status": "cancelled",
    "start_at": "2026-10-20T01:00:00Z",
    "end_at": "2026-10-20T01:30:00Z",
    "guest_name": "佐藤 花子",
    "guest_email": "hanako@example.com",
    "guest_message": "よろしくお願いします。",
    "guest_participants": [],
    "meeting_url": "https://zoom.us/j/123456789",
    "meeting_provider": "zoom",
    "calendar_provider": "google",
    "cancelled_at": "2026-10-08T03:00:00Z",
    "created_at": "2026-10-01T00:00:00Z"
  },
  "dry_run": false
}

appointment のフィールドは list と同じで、status が cancelled になり、 cancelled_at が入ります。--dry-run では現在の appointment(status は confirmed、cancelled_at は null)が入り、 dry_run が true です。--fields と --excludes は appointment のキーに適用されます。各フィールドの説明は Appointment を参照してください。

network_error の後は、キャンセルされたかどうか分かりません。もう一度実行しても安全です (appointment_already_cancelled なら 1 回目でキャンセル済みです)。

エラー

エラーcode終了コード
ID が無い、複数ある、または空(送信前に確認)validation_error4
appointment はすでにキャンセル済み。何も変更しませんappointment_already_cancelled1
カレンダーの予定を削除できなかった(カレンダーの連携解除、アクセスの期限切れ、カレンダー側のエラー)ため、appointment を キャンセルしていない。Rimo でカレンダーを連携し直してから再実行してくださいcalendar_event_delete_failed1
appointment が存在しない、他のユーザーの appointment、またはリンクが削除されているnot_found3
appointments:write が無い(details.required_scopes に必要なスコープが入ります)permission_denied2
組織で機能が有効でないfeature_unavailable2
json
{
  "code": "calendar_event_delete_failed",
  "message": "API error 502: Could not delete the calendar event, so the appointment was not cancelled. Reconnect your calendar in Rimo and retry: https://rimo.app/appointment?tab=personal"
}

エラーの JSON 形式と終了コードについては 出力とエラー を参照してください。


その他 ​

rimo version ​

CLI のバージョンを出力します。

構文

rimo version

出力(stdout, プレーンテキスト)

rimo version 1.0.0

rimo mcp ​

Rimo の MCP サーバーを stdio で起動します。これにより MCP クライアント(Claude Code、 Cursor、Claude Desktop など)が、シェルコマンドではなくツール経由でノートを読めます。

構文

rimo mcp

出力

ありません。これは stdin/stdout で Model Context Protocol を話す常駐サーバーであり、 データを返すコマンドではありません。手動で実行せず、MCP クライアント側で設定して ください。MCP でできること と コーディングツールで使う を参照してください。


rimo 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 をキャプチャするスクリプトには 最終的なステータス行のみが表示されます。

例

bash
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 時間キャッシュされます。