Skip to content

Commands ​

Complete reference for every rimo command. For installation see Installation; for the output contract and error format see Output & errors.

Output contract. All commands print JSON to stdout by default; add --pretty for a human-readable table. A few human-facing commands print plain text on success (errors are always JSON): rimo version, rimo upgrade, rimo note ask, rimo note get with --transcript / --document / --full / --meeting-chat / --document-id, and rimo note asset get (Markdown unless --json is given).

The examples below show the shape of each response. For every field with its type, description, and whether it is always present, see the Response reference.

Global flags (apply to every command):

FlagDescription
--accountAccount alias to use (overrides active_account in config)
--fieldsFields to include: "" (all), "compact", or "f1,f2"
--excludesComma-separated fields to exclude from output
--dry-runSimulate the command without side effects (writes only)
--prettyHuman-readable tables instead of JSON — see Output & errors

Authentication ​

rimo auth login ​

Authenticate with Rimo through a browser-based login.

Syntax

rimo auth login

(also available as the top-level rimo login.)

Flow

By default, rimo auth login opens your browser:

  1. Opens your default browser to authorize this CLI.
  2. Waits for you to sign in if needed and approve the request.
  3. Stores the access + refresh tokens securely using your OS credential store.
  4. Registers an alias in ~/.config/rimo/config.yaml and sets it active.

--no-browser flow

For machines without a usable browser:

  1. Prints a URL to stderr.
  2. Open the URL on any other device, sign in if needed and approve; the page shows a short code.
  3. Paste the code back into the terminal at the prompt.
  4. Stores tokens and registers the alias as above.

Flags

FlagDescription
--no-browserPrint a URL to open on another device, then paste the displayed code back into the terminal.

Alias generation. Auto-generated from the email and org name:

EmailOrg nameGenerated alias
alice@rimo.app(empty)alice-rimo-personal
alice@rimo.app"Client A"alice-rimo-client-a
bob@gmail.com"Acme Co"bob-gmail-acme-co

Re-logging in to the same (user_id, org_id) keeps the original alias and refreshes the metadata.

Output (stdout, JSON)

json
{
  "status": "logged_in",
  "alias": "alice-rimo-personal",
  "email": "alice@rimo.app",
  "name": "Alice",
  "org": "Personal"
}

Field reference: Login and switch result.


rimo auth logout ​

Revoke the token and remove the account from config + credential store.

Syntax

rimo auth logout [--account <alias|email|org>]

If --account is omitted, the active account is logged out. When no active account is configured, the command lists saved accounts and asks you to specify one with --account.

Behavior

  1. Resolves the input to an exact alias (alias, then email, then org name).
  2. Calls the revoke endpoint (best-effort — failures are logged to stderr but do not abort).
  3. Deletes the token from your OS credential store.
  4. Removes the account from config.yaml. If it was active, the active account is cleared (no auto-promotion).

Output (stdout, JSON)

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

Field reference: Logout result.


rimo auth status ​

List all saved accounts and their token status.

Syntax

rimo auth status

Output (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 values: valid, expiring_soon, expired, unknown (token expiry could not be determined).

When RIMO_API_KEY or RIMO_TOKEN is set, the response also carries active_credential (and api_key_hint for an API key) to show that the environment variable — not active_account — is what authenticates requests.

Field reference: Auth status.


rimo auth switch ​

Switch the active account.

Syntax

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

Also available as rimo auth use.

Resolution order

  1. Exact alias match.
  2. email match — errors if the email maps to multiple orgs and --org is not given.
  3. org-name match — orgs belonging to the currently active email are preferred.

Flags

FlagDescription
--orgOrg name to disambiguate when an email is registered under multiple orgs. Compared ignoring case and surrounding spaces; if it still matches more than one of the email's orgs, the command fails and lists their aliases — switch by alias instead.

Examples

bash
rimo auth switch alice-rimo-personal                       # exact alias
rimo auth switch alice@rimo.app                            # by email (errors if multiple orgs)
rimo auth switch "Client A"                                # by org name
rimo auth switch alice@rimo.app --org "Client B"           # email + org disambiguation

Output (stdout, JSON)

json
{
  "status": "switched",
  "alias": "alice-rimo-client-a",
  "email": "alice@rimo.app",
  "name": "Alice",
  "org": "Client A"
}

Field reference: Login and switch result.


Notes ​

What the note commands return depends on your access:

  • rimo note list (default) returns only notes you own.
  • rimo note list --attended returns notes you participated in.
  • rimo note list --team <id> returns a team's notes across all its members (you must be a member of that team). Get team IDs with rimo team list.
  • Notes shared with you by URL only (not via ownership or participation) do not appear in any list, but you can still fetch one directly with rimo note get <id> if you have the ID.
  • rimo note get on a note you cannot access returns a not-found error rather than revealing that the note exists.

rimo note create and rimo note append write: they need a token with the notes:write scope (and, for append, edit access to the note). Every other note command is read-only.

rimo note list ​

List notes.

Syntax

rimo note list [--attended] [--team <id>] [--today] [--week]
               [--since <date>] [--until <date>] [--updated-since <date>]
               [--page-size <int>] [--page-token <string>]

Default mode. Lists notes created by the authenticated user.

--attended mode. Lists notes the authenticated user participated in.

--team mode. Lists a team's notes across all its members. You must be a member of the team; otherwise the request is rejected. --attended cannot be combined with --team or the date filters.

--since / --until filter by meeting time — a note's held_at, or its creation time if it has none. --updated-since filters by when a note was last updated, so you can fetch only what changed since your last run. Dates accept YYYY-MM-DD (read as JST) or an RFC3339 timestamp. --until is exclusive: a note held on the --until date itself is not returned.

--today and --week are shortcuts for the two most common held_at ranges: --today lists notes held today, --week those held in the trailing 7 days (today plus the previous six). Both are evaluated in JST and are exactly equivalent to setting --since/--until by hand, so they cannot be combined with either (or with each other, or with --attended).

All modes are paginated via --page-size and --page-token.

Flags

FlagTypeDefaultDescription
--attendedboolfalseList notes you participated in
--teamstring""List a team's notes across its members (team ID from rimo team list)
--todayboolfalseShortcut for notes held today (JST); conflicts with --since/--until
--weekboolfalseShortcut for notes held in the trailing 7 days (JST); conflicts with --since/--until
--sincestring""Only notes held on or after this date (YYYY-MM-DD or RFC3339)
--untilstring""Only notes held before this date (YYYY-MM-DD or RFC3339)
--updated-sincestring""Only notes updated on or after this date (YYYY-MM-DD or RFC3339)
--page-sizeint0Page size (0 lets the server pick the default)
--page-tokenstring""Cursor from a previous call's next_page_token

Examples

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

Output (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..."
}

Metadata only — note list never returns the transcript, the document markdown, the tags, or the participants. Use rimo note get with a content flag for those. Field reference: Note.


rimo note get ​

Get a single note. By default, only metadata is output as JSON. Additional flags let you retrieve the transcript or document content.

Syntax

rimo note get <note_id> [flags]

Flags

FlagDescription
--transcriptPrint the transcript as plain text in Speaker: content form.
--documentPrint the primary document as markdown plain text.
--fullPrint transcript followed by the primary document, with each attachment shown where the document places it. Attachments it does not place are listed in a final ## Attachments section.
--meeting-chatPrint the web meeting chat (Zoom/Meet) as plain text in [HH:MM] sender: text form.
--list-documentsList documents attached to the note (JSON).
--document-id <id>Print a specific document's markdown by ID.
--timestampsWith --transcript or --full, prefix each transcript line with [HH:MM:SS].

Notes

  • --list-documents / --document-id cannot be combined with --transcript / --document / --full.
  • --list-documents and --document-id are mutually exclusive.
  • --meeting-chat is its own output and cannot be combined with --transcript / --document / --full / --list-documents / --document-id.
  • --timestamps requires --transcript or --full; any other combination is rejected. Without it, transcript output is unchanged.
  • --timestamps shows time elapsed from the start of the recording, so [00:00:11] is 11 seconds in. This differs from --meeting-chat, whose [HH:MM] is the message's wall-clock time.
  • The content flags (--transcript, --document, --full, --meeting-chat, --document-id) print plain text to stdout, not JSON.
  • In --full, an attachment the document places is shown where it stands, pointed at its asset ID with its summary as the link title: [report.pdf](<asset_id> "<summary>") for a file and ![photo.png](<asset_id> "<summary>") for an image (no title while there is no summary). The asset ID is not a path or URL: read the attachment with rimo note asset get <note_id> <asset_id>. An image is matched by the asset ID the document saves with it. In a document saved before images kept their asset ID, an image records only its file name, so it is linked only when that name identifies exactly one attachment; the CLI never guesses between same-name images. Attachments it does not place (those of other documents, and images it cannot identify) are listed in a final ## Attachments section: one - <name> (<id>, <size>[, image]) line per attachment, with its summary on the next line when it has one. When images in the document could not be identified, a > line at the top of the section says so. A note without attachments prints exactly as before. If the attachments cannot be listed, the note is still printed and a warning: line goes to stderr.

Examples

bash
rimo note get note_abc123                          # metadata JSON
rimo note get note_abc123 --transcript             # plain-text transcript
rimo note get note_abc123 --transcript --timestamps # transcript with [HH:MM:SS]
rimo note get note_abc123 --document               # primary document markdown
rimo note get note_abc123 --full                    # transcript + document
rimo note get note_abc123 --meeting-chat           # plain-text Zoom/Meet chat
rimo note get note_abc123 --list-documents         # JSON list of documents
rimo note get note_abc123 --document-id doc_xyz    # specific document markdown
rimo note get note_abc123 --fields id,title        # filter the JSON metadata

Output — default (stdout, JSON)

The note's metadata, wrapped in a note envelope.

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"
  }
}

Field reference: Note.

Output — --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": "## Decisions\n\n- ...",
      "created_at": "2026-05-12T08:30:00+09:00",
      "updated_at": "2026-05-12T10:02:11+09:00"
    }
  ]
}

Every document's full export_markdown is included, so the response grows with the note's content. Add --excludes export_markdown when you only need the IDs and titles. Field reference: Document.

Output — content flags (stdout, plain text)

These flags print text, not JSON — see Note content for the exact form of each.

Errors

See Output & errors for the error JSON shape and exit code.


Find notes by semantic similarity (default), or by keyword and attribute filter. Returns JSON in the same {notes, total_count} shape as rimo note list. Use rimo note ask when you want a synthesised answer instead of a list.

Syntax

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

In --mode=filter the query is optional: omit it to browse by filters alone (team, date range, participant, tag), newest first.

Flags

FlagDescription
--modesemantic (default) ranks notes by meaning; filter does keyword and/or attribute search with pagination.
--limitMax results for --mode=semantic.
--pagePage number for --mode=filter (1-based, default 1).
--perPage size for --mode=filter (default 10, max 100).
--content-typeLimit --mode=filter to one of: all transcripts headings annotations title document.
--team--mode=filter only: restrict to one or more teams. Repeatable or comma-separated; team IDs come from rimo team list.
--participant--mode=filter only: restrict to notes with these participant user IDs. Repeatable or comma-separated.
--note-tag--mode=filter only: restrict to notes with these tag IDs. Repeatable or comma-separated.
--since--mode=filter only: only notes held on or after this date. YYYY-MM-DD (interpreted as JST) or an RFC3339 timestamp.
--until--mode=filter only: only notes held before this date. Same formats as --since.

Output (stdout, JSON)

JSON {notes: [...], total_count: <int>} on stdout. A Fetch a note: hint — and, in filter mode, a page footer and a copy-pasteable next-page command — is printed to stderr so stdout stays pipe-clean for | 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
}

A search hit is not a full note: it carries id plus whatever the search index returned. Both modes return title, held_at, and created_at when available; only --mode=filter adds owner_name and snippet. In --mode=filter, total_count counts the whole result set rather than the current page; in --mode=semantic it is the number of notes returned. Field reference: Search result.

Examples

bash
rimo note search "release plan"                                # semantic (default)
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        # keyword, scoped to a team
rimo note search --mode=filter --team T_abc --since 2026-04-01  # filter-only browse (no query)
rimo note search --mode=filter --since 2026-04-01 --until 2026-07-01
rimo note search "release" --mode=filter | jq '.notes[].id'

Errors

See Output & errors for the error JSON shape and exit code.


rimo note ask ​

Ask a natural-language question and get an AI-synthesised answer drawn from your notes. This is the only command that generates an AI answer.

Syntax

rimo note ask <question>

No flags. The model is fixed server-side.

Output (plain text, streamed)

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

The answer streams as the model generates it. The Sources: block is the canonical citation surface. All three blocks go to stdout — see Ask answer.

When to use which

  • rimo note search — when you'd open the returned notes and read them yourself.
  • rimo note ask — when you'd open them to extract a single answer.

Examples

bash
rimo note ask "what did we decide about Q3 pricing?"
rimo note ask "今週の議事録を要約して"

Errors

See Output & errors for the error JSON shape and exit code.


rimo note create ​

Create a note with no recording attached. A primary document is created alongside it for editing, optionally seeded with markdown.

Requires a token with the notes:write scope.

Syntax

rimo note create [markdown] [flags]

Pass the initial markdown as the positional argument, or via --markdown-file (- reads stdin) — not both. Omit it entirely to create an empty note. For multi-line markdown inline, use bash/zsh $'…' quoting (\n = newline); for anything longer, prefer --markdown-file.

Flags

FlagTypeDefaultDescription
--titlestringautoNote title (defaults to an auto-generated timestamp title)
--teamstring""Create the note under this team (ID from rimo team list); defaults to a personal note
--localestringyour settingNote locale, e.g. ja-JP
--markdown-filestring""Read the initial markdown from a file (- for stdin)

Examples

bash
rimo note create                                            # empty, auto-titled note
rimo note create --title "Blog draft"
rimo note create --title "Blog draft" $'# Intro\nNotes go here.'   # multi-line markdown
rimo note create --markdown-file draft.md --team team_abc123
cat draft.md | rimo note create --markdown-file - --title "Blog draft"
rimo note create --title "Blog draft" --dry-run             # preview, no note created
rimo note create --title "Blog draft" --fields id           # just the new IDs

Output (stdout, JSON)

json
{
  "note": { "id": "note_abc123", "title": "Blog draft", "...": "..." },
  "document": { "id": "doc_xyz789", "primary": true, "...": "..." }
}

Keep both IDs — rimo note append takes the note ID and the document ID.

Field reference: Note and Document. With --dry-run the response is a placeholder example plus "dry_run": true — see Dry-run output.

Errors

400 for a malformed body, an unsupported locale, or a disabled channel; 403 if you are not a member of the given team. See Output & errors for the error JSON shape and exit code.


rimo note append ​

Merge markdown into a note's document as a new section, preserving heading and list structure. Appends to the end by default.

Requires edit access to the note and a token with the notes:write scope.

Syntax

rimo note append <note_id> <document_id> [markdown] [flags]

The markdown is required — pass it as the positional argument or via --markdown-file (- reads stdin), not both. For multi-line markdown inline, use bash/zsh $'…' quoting (\n = newline). Find a note's document IDs with rimo note get <note_id> --list-documents.

Flags

FlagTypeDefaultDescription
--positionstringendInsertion position: end (append) or start (prepend)
--markdown-filestring""Read the markdown from a file (- for stdin)

Examples

bash
rimo note append note_abc123 doc_xyz789 $'## Action items\n- Ship the release notes'
rimo note append note_abc123 doc_xyz789 --markdown-file section.md
rimo note append note_abc123 doc_xyz789 --position start "## Summary"
rimo note ask "what did we decide?" | rimo note append note_abc123 doc_xyz789 -
rimo note append note_abc123 doc_xyz789 "## Notes" --dry-run

Output (stdout, JSON)

json
{
  "document": {
    "id": "doc_xyz789",
    "export_markdown": "# Intro\n\n## Action items\n\n- Ship the release notes",
    "...": "..."
  }
}

export_markdown reflects the document after the merge, so you can confirm what landed. Field reference: Document. With --dry-run the response is a placeholder example plus "dry_run": true, not a preview of your merge — see Dry-run output.

Errors

400 for empty markdown or an invalid --position; 403 without edit access; 404 for an unknown note or document; 409 if the note or document is locked. See Output & errors for the error JSON shape and exit code.

rimo note asset list ​

List the file attachments — uploaded files and images embedded in the body — referenced by a note's documents.

Syntax

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

By default, lists attachments across every document on the note. Pass --document-id to scope the listing to one document instead. Find a note's document IDs with rimo note get <note_id> --list-documents.

Each attachment carries a summary_status that says whether its short summary is available. summary is included exactly when summary_status is completed:

summary_statusMeaning
noneNo summary for now, and analysis may not have started yet: a newly uploaded attachment can show none for a short time before it moves to pending or processing. Also used when the file type is not analyzed, nothing readable was found in it, or an image was skipped because the note already has the maximum number of analyzed images (200)
pendingWaiting to be analyzed
processingBeing analyzed
completedThe summary is available
failedThe latest analysis failed; some failures are retried automatically, so it can still change

Attachment analysis is currently enabled for selected organizations only. In other organizations every attachment shows none, and rimo note asset get reports Not analyzed.

Use rimo note asset get for the full analysis and the extracted text.

Flags

FlagTypeDefaultDescription
--document-idstring""List assets for this document only, instead of every document on the note

Examples

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

Output (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": "Proposed Q3 price changes per plan and the migration schedule."
    }
  ]
}

Output (stdout, --pretty, 100 columns)

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

1 asset

Field reference: Asset.

Errors

403 without access to the note; 404 for an unknown note or document. See Output & errors for the error JSON shape and exit code.

rimo note asset get ​

Show one attachment: its details, the summary and other results of its analysis, and the text extracted from the file, as Markdown.

Syntax

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

Get attachment IDs from rimo note asset list <note_id>.

The Markdown has a header with the attachment's details and analysis state, then ## Summary when the analysis produced one, and finally ## Content with the extracted text exactly as stored — including its <!-- @loc page_from=… page_to=… --> page markers.

Anything short of a complete result is stated in a note above the content:

SituationWhat the output says
The attachment has not been analyzed (for example, it was uploaded before attachment analysis was available)Not analyzed — no summary or content
The analysis is queued or still runningAnalysis pending / Analysis in progress — try again later
The file type is not analyzedNot supported
The image was skipped because the note already has the maximum number of analyzed images (200); the analysis status is skipped with error code image_limit_reachedNot analyzed — no summary or content
The analysis failedAnalysis failed with the error code; text extracted before the failure is still shown when there is some
Only part of the file could be readPartial coverage
Images or charts were not readUnread visuals with their pages
The text is larger than 1 MiBTruncated — the first 1 MiB is shown, with the full size

This command only reads results that already exist; it never starts or re-runs an analysis. Like rimo note get --full, it counts toward the daily limit on reading note contents.

Flags

FlagTypeDefaultDescription
--jsonboolfalsePrint the response as JSON instead of Markdown. --fields / --excludes / --pretty then apply to its top-level keys.

Examples

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

Output (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: en

## Summary

Proposed Q3 price changes per plan and the migration schedule.

## Content

<!-- @loc page_from=1 page_to=1 -->
## Q3 pricing
...

With --json: {asset, analysis, content, content_size_bytes, content_truncated} — see AssetDetail.

Errors

403 without access; 404 when the note does not exist, you cannot read it, or the attachment is not one rimo note asset list shows for it; 429 when the daily limit is reached. Errors are always JSON — see Output & errors for the shape and exit codes.

rimo note asset upload ​

Upload a local file and insert it into a note's document as an image or file, in one step: create the asset record, upload the file bytes to the signed URL the backend returns, then attach it.

Requires edit access to the note and the notes:write scope.

Syntax

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

Omit --document-id to attach to the note's primary document (created if it doesn't exist yet). Pass --document-id to attach to one exact document instead (from rimo note get <note_id> --list-documents) — that document must already exist; there is no fallback to the primary document.

Without --section-title, --position places the file at the start or end of the document. With --section-title, it places it in the section under that heading instead: start right after the heading, end (the default) at the end of the section, after any subsections. If no heading matches, the command fails with a 404 and the document is not changed.

The heading text must match exactly, including case: Backend and backend are different headings. Surrounding spaces and leading # marks are ignored.

If several headings have the same text, the file is placed relative to the first one. The upload still succeeds — exit code 0 and the same JSON on stdout — and a warning is printed to stderr:

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

The MIME type is always auto-detected from the file extension — there is no override flag. Supported types: images (.jpg, .jpeg, .png, .webp), PDF (.pdf), and Office documents (.doc, .docx, .xls, .xlsx, .ppt, .pptx). A file with any other extension, or no extension, is rejected before any request is made.

Maximum file size: 10MB for images, 100MB for other files. An oversized file is rejected locally, before any request is made; the backend enforces the same limit as the final authority.

Flags

FlagTypeDefaultDescription
--document-idstring""Attach to this document instead of the note's primary document
--namestringfile's base nameAsset name
--altstring""Alt text for an image (omitted — the backend defaults it to the asset's name)
--widthint0Image width in pixels
--heightint0Image height in pixels
--positionstringendInsertion position: start or end
--section-titlestring""Exact, case-sensitive heading text of the section to insert into

Examples

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 "Team photo" --width 1200 --height 800
rimo note asset upload note_abc123 pricing.pptx --dry-run   # preview the create-asset request only

Output (stdout, JSON)

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

Field reference: Asset and Document. With --dry-run, only the create-asset step is simulated — the upload and attach steps need a real signed URL and asset ID from a real response, which a client-side simulation can't produce. Response is a placeholder example plus "dry_run": true; see Dry-run output.

Errors

400 for an unsupported file type, an oversized file, or an invalid --position; 403 without edit access, or if file uploads are disabled for your organization; 404 for an unknown note, or a --document-id that doesn't belong to (or isn't accessible on) the note; 409 if the note or document is locked. See Output & errors for the error JSON shape and exit code.


Teams ​

rimo team list ​

List teams in your organization. The returned team IDs can be passed to rimo note list --team <id> to list a team's notes across all its members.

Syntax

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

Flags

FlagTypeDefaultDescription
--page-sizeint0Page size (0 lets the server pick the default, currently 20)
--page-tokenstring""Cursor from a previous call's next_page_token
--include-organizationboolfalseAlso return your organization's own folder (see below)

Examples

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

Output (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..."
}

A team's name is the folder name you see in the Rimo app. Field reference: Team.

Your organization's own folder

Alongside its team folders, an organization has a folder of its own — notes live in it like any other folder, and its id is the organization's id. It is left out by default; --include-organization returns it, with "category": "organization" to tell it apart from a team folder.

It is added to the first page only, so that page carries one row more than --page-size and later pages are unaffected.


An appointment link is a page you share with guests to book time with you: a guest picks a time in the browser and the appointment lands on your calendar. These commands read, create, change, disable, enable and delete your own links, and list and cancel the appointments made through them; links other members own are not listed.

The read commands need a token with the appointments:read scope, and create, update, enable, disable, delete and appointment cancel need appointments:write. A session from rimo auth login picks them up on its next refresh; a personal API key created before a scope existed does not, so create a new key if you see insufficient_scope (requires …). Appointment links are available only to organizations where the feature is enabled; elsewhere these commands return API error 403: appointment links are not available for this organization. The check uses the organization you signed in to, so switch with rimo auth switch if you belong to more than one.

List your appointment links, newest first. Disabled and closed links are included.

Syntax

rimo appointment link list

Examples

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

Output (stdout, JSON)

json
{
  "appointment_links": [
    {
      "id": "J9yyjDQLJWqhiSTH0sAT",
      "url": "https://rimo.app/appointment/guest/J9yyjDQLJWqhiSTH0sAT",
      "edit_url": "https://rimo.app/appointment/J9yyjDQLJWqhiSTH0sAT/edit",
      "title": "30-minute meeting",
      "duration_minutes": 30,
      "disabled": false,
      "closed": false,
      "single_use": false,
      "calendar_provider": "google",
      "meeting_providers": ["google_meet"],
      "participants": [
        { "user_id": "AZ2zlcmEGKMeD30Fn4tAiuzd3U63", "name": "Taro Yamada", "email": "taro@example.com" }
      ],
      "created_at": "2026-09-01T00:00:00Z",
      "updated_at": "2026-09-02T00:00:00Z"
    }
  ]
}

url is the booking page to share with a guest. Field reference: Appointment link. Use get <id> for a link's full settings.

Show one of your appointment links with all of its settings: the fields list prints, plus the bookable hours, time zone, booking window, notice, buffers, slot interval, cancellation deadline, keywords, holidays, date overrides and notification settings. A link you do not own is reported as not found, the same as a missing one.

The output uses the same field names as the create -f and update -f files, so it is also a valid starting file: save it, edit it, and pass it back to copy a link (create) or change this one (update).

Syntax

rimo appointment link get <link-id>

Examples

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

Output (stdout, JSON)

json
{
  "appointment_link": {
    "id": "J9yyjDQLJWqhiSTH0sAT",
    "url": "https://rimo.app/appointment/guest/J9yyjDQLJWqhiSTH0sAT",
    "edit_url": "https://rimo.app/appointment/J9yyjDQLJWqhiSTH0sAT/edit",
    "title": "30-minute meeting",
    "description": "Pick a time that suits you.",
    "duration_minutes": 30,
    "disabled": false,
    "closed": false,
    "single_use": false,
    "calendar_provider": "google",
    "meeting_providers": ["google_meet"],
    "participants": [
      { "user_id": "AZ2zlcmEGKMeD30Fn4tAiuzd3U63", "name": "Taro Yamada", "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": "New Year holidays" }
    ],
    "poll_enabled": false,
    "created_at": "2026-09-01T00:00:00Z",
    "updated_at": "2026-09-02T00:00:00Z"
  }
}

Field reference: Appointment link detail.

Errors

ErrorcodeExit
No such link, or another user's linknot_found3
Missing appointments:read (details.required_scopes names it)permission_denied2
The feature is not enabled for your organizationfeature_unavailable2
No ID, or more than onevalidation_error4

See Output & errors for the error JSON shape and exit code.

Create one of your own appointment links. The response is the new link with every setting; its url is the booking page to share with a guest.

Only the title is required. Every field you leave out comes from your personal settings (個人設定) in the Rimo app, then from the system defaults in the file keys table, so a link made with just --title books like one made in the app. The CLI fills in nothing: only the flags you pass and the keys in your file are sent.

Needs the appointments:write scope. A session from rimo auth login picks it up on its next refresh; a personal API key created before the scope existed does not, so create a new key if you see insufficient_scope (requires appointments:write).

Syntax

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

Run it with --dry-run first. The server checks and completes the request exactly as it would for a real create and returns the final link without saving it, so you see every resolved setting before anything is created. A dry run has no id, url or edit_url yet (they are ""): the url to share comes from the real create.

Flags

FlagBody fieldDescription
--titletitleLink title. Required unless the file has title.
--descriptiondescriptionText shown to the guest on the booking page.
--durationduration_minutesMeeting length in minutes.
--daysavailability_rulesBookable days: names (sun mon tue wed thu fri sat, or full names, any case), lists (mon,wed) and ranges (mon-fri, sat-sun). Numbers and ranges that wrap past the end of the week (fri-mon) are refused. Needs --hours.
--hoursavailability_rulesBookable hours on each of --days, as HH:MM-HH:MM. Repeat it for more than one band a day. Needs --days.
--time-zonetime_zoneIANA time zone the hours are in, for example Asia/Tokyo.
--calendarcalendar_providergoogle or outlook.
--meetingmeeting_providersMeeting tool, tried in the order given: meet, zoom, teams (or google_meet, microsoft_teams). Repeat it or comma-separate.
--no-meetingmeeting_providersIssue no meeting URL (sends []).
--co-hostsparticipantsMembers of your organization who host with you, by email or user ID, comma-separated or repeated. A value with @ is an email.
--single-usesingle_useClose the link after its first booking.
--auto-record / --no-auto-recordauto_reserve_recordingRecord meetings booked through the link, or not. Applies to bookings made after the link is saved.
--closes-oncloses_onLast bookable day, YYYY-MM-DD.
-f, --filethe whole bodyJSON file with the link's settings; - reads stdin.

--days mon-fri --hours 10:00-12:00 --hours 13:00-17:00 makes one rule per day and band (ten rules). For different hours on different days, use availability_rules in the file.

Co-hosts are members of your organization whose calendars must be free too. They are not guests — guests book through the link's url.

A flag wins over the same key in the file. --days/--hours cannot be combined with availability_rules in the file, and --meeting with --no-meeting or --auto-record with --no-auto-record contradict each other; all of these are refused before any request is sent.

File keys ​

The file is one JSON object using the same field names get prints. The output of get (or of a create --dry-run) can be passed back as is: the {"appointment_link": {...}} envelope is accepted (with warnings and dry_run next to appointment_link ignored; any other key there is refused with unknown_field), the read-only keys id, url, edit_url, closed, created_at and updated_at are ignored, disabled and poll_enabled are ignored while they are false, and each co-host is sent by its user_id. warnings and dry_run inside the link object itself (a bare file, or inside appointment_link) are not settings and are refused with unknown_field, so a stray "dry_run": true cannot turn into a real create: use --dry-run for a dry run. A copied link with "disabled": true or "poll_enabled": true is refused with unknown_field, because create cannot make a disabled link or a group poll: set the key to false or remove it. Any other key the server does not know is refused with unknown_field.

The default applies when the key is left out and your personal settings do not set it.

KeyType / valuesDefault
titlestring— (required)
descriptionstring""
duration_minutesinteger, 5–72030
availability_rulesarray of {"weekday": 0–6 (0 = Sunday), "start_time": "HH:MM", "end_time": "HH:MM"}Monday–Friday 09:00–18:00
time_zoneIANA nameAsia/Tokyo
days_in_advanceinteger, 1–365: how far ahead guests can book14
closes_on"YYYY-MM-DD" (last bookable day) or "" (no end date)""
min_notice_hoursinteger, 0–72024
buffer_before_minutesinteger, 0–7200
buffer_after_minutesinteger, 0–7200
appointment_slot_interval_minutesinteger, 0–720; 0 = the meeting length0
single_usebooleanfalse
auto_reserve_recordingbooleantrue
cancellation_deadline_hoursinteger, 0–720; 0 = until the start0
calendar_provider"google" | "outlook"your connected calendar (google when both are)
meeting_providersordered array of "google_meet" | "zoom" | "microsoft_teams"; [] = no meeting URLgoogle_meet on Google, microsoft_teams on Outlook
participantsco-hosts: array of {"user_id": "..."} or {"email": "..."}; when both are given, user_id is used[]
include_keywordsarray of strings[]
include_keywords_onlyboolean; needs include_keywordsfalse
exclude_keywordsarray of strings[]
holiday_countriesarray of ISO country codes, for example ["JP"]; Google calendar only[] with no personal settings; ["JP"] when personal settings exist but do not set holidays
time_overridesarray of {"type": "block" | "open", "start_date", "end_date": "YYYY-MM-DD", "start_time", "end_time": "HH:MM", "note"}[]
disable_appointment_confirmed_emailbooleanfalse
share_note_with_guestbooleanfalse

A full file:

json
{
  "title": "Intro call",
  "description": "A short call to get to know each other.",
  "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": "New Year" }
  ],
  "disable_appointment_confirmed_email": false,
  "share_note_with_guest": false
}

Examples

bash
rimo appointment link create --title "Intro call" --dry-run    # see the resolved link, create nothing
rimo appointment link create --title "Intro call"
rimo appointment link create --title "Intro call" --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 "Copy"
rimo appointment link create --title "Intro call" --fields url  # just the URL to share

Output (stdout, JSON)

json
{
  "appointment_link": {
    "id": "Kq3pX9vB2mLwT7yZ1cDe",
    "url": "https://rimo.app/appointment/guest/Kq3pX9vB2mLwT7yZ1cDe",
    "edit_url": "https://rimo.app/appointment/Kq3pX9vB2mLwT7yZ1cDe/edit",
    "title": "Intro call",
    "duration_minutes": 30,
    "...": "every setting, as in 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 has the same fields as get (field reference: Appointment link detail). warnings lists things worth knowing that did not stop the link; each is also printed to stderr as one warning: … line. With --dry-run the link is not saved, dry_run is true, and id, url and edit_url are "". --fields and --excludes apply to the link.

If the request fails with network_error, the link may or may not have been made: check rimo appointment link list before running the command again.

Errors

ErrorcodeExit
A key the server does not know (details names every wrong key, a suggestion and the accepted keys)unknown_field4
Malformed JSON or a value of the wrong typeinvalid_request4
A value out of range or in the wrong format (details[].field is its path)invalid_field4
Settings that could never offer a bookable timeno_bookable_window4
No calendar connectedhost_calendar_not_connected4
The calendar is connected without permission to write eventshost_calendar_write_scope_missing4
A co-host is not a member of your organizationparticipant_not_found4
A co-host has no calendar connectedparticipant_calendar_not_connected4
None of the meeting tools can issue a meeting URL (pass --no-meeting for none)no_meeting_provider_available4
No title, contradictory flags, a bad --days/--hours, or a file that is not one JSON object (checked before sending)validation_error4
The -f file cannot be read (checked before sending)validation_error4
Missing appointments:write (details.required_scopes names it)permission_denied2
The feature is not enabled for your organizationfeature_unavailable2
The request body is too largerequest_too_large1

See Output & errors for the error JSON shape and exit code.

Change one of your own appointment links. Only what you pass changes — the flags you set and the keys in your file — and every other setting keeps its current value. The response is the whole link after the change.

Nothing is filled in from your personal settings or the defaults, unlike create. The server checks the link as it will be after the change, with the same rules as create, so a change that leaves the link unable to offer a time, or points it at a calendar or meeting tool you have not connected, is refused. Values you send are never rewritten: moving to --calendar outlook while the link uses Google Meet is refused until you also pass --meeting (or --no-meeting).

Needs the appointments:write scope (see create).

Syntax

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

Run it with --dry-run first: the server checks the change exactly as it would for a real update and returns the link as it would be saved, without saving.

Flags

The same flags as create, plus --no-co-hosts. None is required, but at least one flag or file key must be given.

FlagBody fieldDescription
--titletitleNew title.
--descriptiondescriptionText shown to the guest; --description "" clears it.
--durationduration_minutesMeeting length in minutes.
--days + --hoursavailability_rulesReplace every bookable-hours rule (same syntax as create).
--time-zonetime_zoneIANA time zone.
--calendarcalendar_providergoogle or outlook. Pass --meeting too when the current meeting tool does not work with the new calendar.
--meetingmeeting_providersReplace the meeting tools, tried in the order given.
--no-meetingmeeting_providersIssue no meeting URL (sends []).
--co-hostsparticipantsReplace the whole co-host list: pass every co-host to keep.
--no-co-hostsparticipantsRemove every co-host (sends []).
--single-usesingle_useClose the link after its first booking; --single-use=false turns it off.
--auto-record / --no-auto-recordauto_reserve_recordingRecord meetings booked from now on, or not.
--closes-oncloses_onLast bookable day, YYYY-MM-DD; --closes-on "" removes the end date.
-f, --filethe keys to changeJSON file; - reads stdin.

How a change is applied

  • A key you leave out, or set to null in the file, keeps its value.
  • Lists replace the stored list as a whole: availability_rules, participants, meeting_providers, include_keywords, exclude_keywords, holiday_countries and time_overrides. There is no "add one" — send the full list you want.
  • "" clears a string (description, closes_on) and [] empties a list. title, time_zone, calendar_provider and availability_rules cannot be emptied (400 invalid_field).
  • The date checks — closes_on not in the past, and min_notice_hours fitting the booking window — run only when the request changes closes_on, min_notice_hours or time_zone to a value other than the stored one (closes_on is a date in the link's time zone), so a link past its end date can still be renamed or have its end date removed.
  • The calendar, co-host and meeting tool checks run only when calendar_provider, participants or meeting_providers change. A value equal to the stored one is not a change (for co-hosts: the same people in the same order, by user_id).

The file takes the create file keys (only the defaults do not apply). The output of get can be passed back as is: the envelope is accepted (with warnings and dry_run next to appointment_link ignored), the read-only keys (id, url, edit_url, closed, created_at, updated_at) and disabled are ignored (an update never turns a link on or off: use disable and enable), poll_enabled is ignored whatever its value (a group-poll link itself is refused with poll_link_not_supported), and each co-host is sent by its user_id. As with create, warnings and dry_run inside the link object itself are refused with unknown_field, so a stray "dry_run": true cannot turn into a real update: use --dry-run. Values equal to the stored ones are not changes, so a link past its end date can be passed back as is; still, prefer sending only the keys you change. A flag wins over the same key in the file, except --days/--hours, which cannot be combined with availability_rules in the file.

Examples

bash
rimo appointment link update J9yyjDQLJWqhiSTH0sAT --duration 60 --dry-run    # check first
rimo appointment link update J9yyjDQLJWqhiSTH0sAT --duration 60
rimo appointment link update J9yyjDQLJWqhiSTH0sAT --days mon-thu --hours 10:00-17:00   # replaces all rules
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 ""                # no end date
echo '{"buffer_before_minutes": 10}' | rimo appointment link update J9yyjDQLJWqhiSTH0sAT -f -
rimo appointment link get J9yyjDQLJWqhiSTH0sAT > link.json   # edit link.json, then:
rimo appointment link update J9yyjDQLJWqhiSTH0sAT -f link.json

Output (stdout, JSON)

The same {appointment_link, warnings, dry_run} shape as create: appointment_link is the whole link after the change, each warning is also printed to stderr, and --fields / --excludes apply to the link. With --dry-run, nothing is saved and dry_run is true. An update sets values rather than adding to them, so it is safe to run again after a network_error.

Errors

ErrorcodeExit
Nothing to change: no flag and no file key (checked before sending)validation_error4
Contradictory flags (--co-hosts with --no-co-hosts, …), a bad --days/--hours, no ID, or a file that is not one JSON object (checked before sending)validation_error4
Nothing left to change once null values and ignored keys are set asideempty_update4
A group-poll link, which is managed in the Rimo web apppoll_link_not_supported4
A key the server does not knowunknown_field4
Malformed JSON or a value of the wrong typeinvalid_request4
A value out of range or in the wrong format, or a combination that does not work (for example Google Meet on Outlook); details[].field is its pathinvalid_field4
The link could never offer a bookable time after the changeno_bookable_window4
host_calendar_not_connected, host_calendar_write_scope_missing, participant_not_found, participant_calendar_not_connected, no_meeting_provider_availableas in create4
A single-use link that already has its booking and is closed: create a new linklink_closed1
No such link, or another user's linknot_found3
The -f file cannot be read (checked before sending)validation_error4
Missing appointments:write (details.required_scopes names it)permission_denied2
The feature is not enabled for your organizationfeature_unavailable2
The request body is too largerequest_too_large1

See Output & errors for the error JSON shape and exit code.

Stop new bookings through one of your own appointment links. The link, its settings and its URL stay, and so do the appointments already booked through it: they keep their calendar events and meeting URLs and are still listed by rimo appointment list. A guest who opens the URL can no longer book. Turn the link back on with enable.

Disabling a link that is already disabled succeeds and changes nothing. Needs the appointments:write scope.

Disabling does not check the link's settings or its calendar and meeting integrations, so even a link that can no longer be booked as it is (for example one made in the Rimo app with a combination the API refuses) can be turned off. They are all checked again when you enable it.

Syntax

rimo appointment link disable <link-id>

No flags besides the global ones. --dry-run asks the server, which answers as for a real change and returns the link as it would be saved, without saving.

Examples

bash
rimo appointment link disable J9yyjDQLJWqhiSTH0sAT --dry-run   # check first
rimo appointment link disable J9yyjDQLJWqhiSTH0sAT
rimo appointment list J9yyjDQLJWqhiSTH0sAT                     # the booked appointments stay

Output (stdout, JSON)

The same {appointment_link, warnings, dry_run} shape as update, with "disabled": true in the link. Safe to run again after a network_error.

Errors

ErrorcodeExit
No ID, more than one, or a blank one (checked before sending)validation_error4
A group-poll link, which is managed in the Rimo web apppoll_link_not_supported4
A single-use link that already has its booking and is closedlink_closed1
No such link, or another user's linknot_found3
Missing appointments:write (details.required_scopes names it)permission_denied2
The feature is not enabled for your organizationfeature_unavailable2

Let guests book through a disabled link again, after disable or switching it off in the Rimo app. The link keeps its settings and its URL.

Before turning it on, the server checks the link again with the same rules as create, because things may have changed while it was off:

  • your calendar is still connected, with permission to add events;
  • every co-host is still an active member of your organization and still has a calendar Rimo can read;
  • at least one of its meeting tools can still issue a meeting URL (unless the link issues none);
  • its settings still fit together and leave a time a guest can book, by the same rules as update: a booking fits the availability rules, the notice period is shorter than the booking window, and block overrides do not cover every window.

An end date (closes_on) that has already passed is not checked: the link turns on, but guests still cannot book until you move the end date with update --closes-on YYYY-MM-DD or remove it with update --closes-on "".

If a check fails, the link stays disabled and the error says what to fix. Fix it in the Rimo app or with update, then enable again. Enabling a link that is already on changes nothing. Needs the appointments:write scope.

Syntax

rimo appointment link enable <link-id>

No flags besides the global ones. Run it with --dry-run first: the server runs the same checks and returns the link as it would be saved, without saving.

Examples

bash
rimo appointment link enable J9yyjDQLJWqhiSTH0sAT --dry-run   # check that it can be turned on
rimo appointment link enable J9yyjDQLJWqhiSTH0sAT
rimo appointment link enable J9yyjDQLJWqhiSTH0sAT --fields id,disabled,url

Output (stdout, JSON)

The same {appointment_link, warnings, dry_run} shape as update, with "disabled": false in the link. A warning (for example a meeting tool that can no longer issue a URL while another still can) is also printed to stderr. Safe to run again after a network_error.

Errors

ErrorcodeExit
No ID, more than one, or a blank one (checked before sending)validation_error4
Your calendar is no longer connected, or Outlook lacks permission to add eventshost_calendar_not_connected, host_calendar_write_scope_missing4
A co-host is no longer an active member of your organization: remove them with update --co-hostsparticipant_not_found4
A co-host no longer has a calendar Rimo can readparticipant_calendar_not_connected4
None of the link's meeting tools can issue a meeting URLno_meeting_provider_available4
The link's settings can no longer offer a bookable time, or no longer fit together; details[].field is the pathno_bookable_window, invalid_field4
A group-poll link, which is managed in the Rimo web apppoll_link_not_supported4
A single-use link that already has its booking and is closed: create a new linklink_closed1
No such link, or another user's linknot_found3
Missing appointments:write (details.required_scopes names it)permission_denied2
The feature is not enabled for your organizationfeature_unavailable2

See Output & errors for the error JSON shape and exit code.

Delete one of your own appointment links. Its URL stops working at once and the link cannot be restored. To stop new bookings but keep the link, use disable instead: it keeps the link, its URL and its appointments, and enable undoes it.

Deleting a link never cancels the appointments booked through it: their calendar events, meeting URLs and scheduled recordings stay. But once the link is gone, those appointments can no longer be listed or cancelled through Rimo, the guest's cancel page stops working, and the guest no longer gets the meeting notes automatically. So while the link has upcoming appointments (confirmed, starting now or later), the server refuses the delete with link_has_upcoming_appointments and deletes nothing; the error lists the earliest 10 in details (the message has the full count; rimo appointment list <link-id> shows them all). Either cancel them first with rimo appointment cancel <appointment-id> (each id in details) and delete again, or re-run with --keep-appointments to delete the link and keep them. Past and cancelled appointments never block a delete.

Group-poll links can be deleted too, and the responses they collected are deleted with them. Needs the appointments:write scope.

Syntax

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

Flags

FlagTypeDefaultDescription
--keep-appointmentsboolfalseDelete even if the link has upcoming appointments. They stay booked, but can no longer be listed or cancelled through Rimo, and their guests no longer get the meeting notes automatically

--dry-run asks the server, which runs the same checks (the upcoming-appointments check included) and answers without deleting. There is no confirmation prompt: the upcoming-appointments check is the server's.

Examples

bash
rimo appointment link delete J9yyjDQLJWqhiSTH0sAT --dry-run              # check first
rimo appointment link delete J9yyjDQLJWqhiSTH0sAT
rimo appointment link delete J9yyjDQLJWqhiSTH0sAT --keep-appointments    # keep its upcoming appointments
rimo appointment link disable J9yyjDQLJWqhiSTH0sAT                       # or only stop new bookings

Output (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 is the number of upcoming appointments the link had; it is above 0 only with --keep-appointments, which also adds the link_had_upcoming_appointments warning (printed to stderr as well). With --dry-run, deleted is false and dry_run is true. --fields and --excludes apply to these keys. Field reference: Appointment link delete result.

After a network_error the link may or may not have been deleted: check with rimo appointment link get <link-id> (not_found means it is gone).

Errors

ErrorcodeExit
No ID, more than one, or a blank one (checked before sending)validation_error4
The link has upcoming appointments and --keep-appointments was not given; details[] lists the earliest 10 (id, start_at, guest_name) and the message has the full count. Nothing is deletedlink_has_upcoming_appointments1
No such link, or another user's linknot_found3
Missing appointments:write (details.required_scopes names it)permission_denied2
The feature is not enabled for your organizationfeature_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."
}

See Output & errors for the error JSON shape and exit code.

rimo appointment list ​

List the confirmed appointments of one of your appointment links, earliest first. Past appointments are included; cancelled ones are not.

Syntax

rimo appointment list <link-id>

<link-id> is the link's id, from rimo appointment link list.

Examples

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

Output (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": "Hanako Sato",
      "guest_email": "hanako@example.com",
      "guest_message": "Looking forward to it.",
      "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"
    }
  ]
}

Every listed appointment has status confirmed and cancelled_at null. A link you do not own is reported as not found, the same as a missing one. Field reference: Appointment.

rimo appointment cancel ​

Cancel one appointment made through one of your appointment links. It does exactly what cancelling it in the Rimo app does:

  • The calendar event is deleted from your calendar, and the calendar sends the guest its cancellation notice (Google Calendar notifies every attendee). If the event cannot be deleted, nothing is cancelled and the command fails with calendar_event_delete_failed: reconnect your calendar in Rimo (the message has the settings URL) and run it again.
  • The recording bot booked for the meeting is released.
  • A Zoom meeting issued for the appointment is deleted. A Microsoft Teams meeting is kept.
  • Rimo sends no cancellation email of its own.

A cancellation cannot be undone: the guest has to book again. Past appointments and appointments of group-poll links can be cancelled too. Needs the appointments:write scope.

The appointment ID alone is enough; the link ID is not needed. Find it with rimo appointment list <link-id> (each appointment's id); cancelled appointments no longer appear there.

Syntax

rimo appointment cancel <appointment-id>

--dry-run asks the server, which checks that the appointment exists, is yours and is not already cancelled, and returns the appointment as it is now, with "dry_run": true, without cancelling it. It does not contact the calendar, so a dry run can pass and the real cancel still fail with calendar_event_delete_failed. There is no confirmation prompt.

Examples

bash
rimo appointment list J9yyjDQLJWqhiSTH0sAT --fields id,start_at,guest_name   # find the ID
rimo appointment cancel J9yyjDQLJWqhiSTH0sAT-1791248400 --dry-run                  # check first
rimo appointment cancel J9yyjDQLJWqhiSTH0sAT-1791248400
rimo appointment cancel J9yyjDQLJWqhiSTH0sAT-1791248400 --fields id,status,cancelled_at

Output (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": "Hanako Sato",
    "guest_email": "hanako@example.com",
    "guest_message": "Looking forward to it.",
    "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 has the same fields as in list, now with status cancelled and cancelled_at set. With --dry-run it is the appointment as it is now (status confirmed, cancelled_at null) and dry_run is true. --fields and --excludes apply to the appointment's keys. Field reference: Appointment.

After a network_error the appointment may or may not have been cancelled. Running the command again is safe: appointment_already_cancelled means the first one went through.

Errors

ErrorcodeExit
No ID, more than one, or a blank one (checked before sending)validation_error4
The appointment is already cancelled. Nothing changesappointment_already_cancelled1
The calendar event could not be deleted (calendar disconnected, expired access, provider error), so the appointment was not cancelled. Reconnect the calendar in Rimo and retrycalendar_event_delete_failed1
No such appointment, another user's appointment, or its link was deletednot_found3
Missing appointments:write (details.required_scopes names it)permission_denied2
The feature is not enabled for your organizationfeature_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"
}

See Output & errors for the error JSON shape and exit code.


Misc ​

rimo version ​

Print the CLI version.

Syntax

rimo version

Output (stdout, plain text)

rimo version 1.0.0

rimo mcp ​

Run the Rimo MCP server on stdio, so an MCP client (Claude Code, Cursor, Claude Desktop, …) can read your notes through tools instead of shell commands.

Syntax

rimo mcp

Output

None — this is a long-running server that speaks the Model Context Protocol on stdin/stdout, not a data command. Do not run it by hand; configure it in your MCP client. See What you can do with MCP and the Rimo in Coding Tools.


rimo upgrade ​

Upgrade the installed binary to the latest release.

rimo upgrade always installs the latest release — there is no flag to pin or downgrade to an older version. The release archive is downloaded over HTTPS and its checksum is verified against the release's checksums.txt before the running binary is replaced; no login is required.

Syntax

rimo upgrade [--check] [--use-sudo]

Flags

FlagDescription
--checkReport whether an update is available; do not download or install.
--use-sudoRetry via sudo install -m 0755 if the install path is not writable. Opt-in.

Output (stdout, plain text)

One of:

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.

Progress messages go to stderr, so a script capturing stdout sees only the final status line.

Examples

bash
rimo upgrade --check                   # is there a newer release?
rimo upgrade                           # latest
sudo rimo upgrade --use-sudo           # retry under sudo for root-owned install dirs

Errors

See Output & errors for the error JSON shape and exit code.

Startup update notice

Every invocation runs a non-blocking background version check. If a newer release is available, a single line is written to stderr (never stdout):

rimo: update available v1.0.0 → v1.1.0 (run: rimo upgrade)

The notice is suppressed when the binary is a local dev build, when RIMO_NO_UPDATE_CHECK is set, when CI is set, or for the upgrade, version, and --help invocations. The result is cached for 24 hours.