@circleback/cli

中文文档
1.3.1发布于 2026/11/07MIT近 30 天下载 5428

Circleback CLI. Search and access meetings, emails, calendar events, and more.

原始使用文档
文档目录9 节
  1. Installation
  2. Quick start
  3. Commands
  4. Meeting identifiers
  5. Filtering
  6. JSON output
  7. Login
  8. Agents
  9. Links

Circleback CLI

Search and access your meetings, transcripts, emails, calendar events, and more from the terminal, and manage your action items, tags, folders, and meeting access.

Installation

npm install -g @circleback/cli

Requires Node.js 18 or later. The package installs two binaries: circleback and cb (shorthand).

Quick start

# Log in with your browser
cb auth login

# Search recent meetings
cb meetings

# Search by keyword
cb meetings "product review"

# Read by ID (from the meeting URL, e.g. circleback.ai/meetings/abc123)
cb meetings read abc123

# Search transcripts
cb transcripts "pricing discussion"

# Search emails
cb emails "from:[email protected] after:2026-01-01"

# Mark an action item done
cb action-items update 123 --status DONE

# Get raw JSON for scripting
cb meetings --json

Commands

CommandDescription
cb auth loginLog in to Circleback with your browser
cb auth login --api-keyLog in with an API key
cb auth logoutSign out on this device
cb updateUpdate CLI to the latest version
cb meetings [search]Search meetings
cb meetings read <ids...>Read detailed meeting info, notes, and action items (max 50)
cb meetings update <id>Update a meeting
cb meetings share <id>Share a meeting or remove access
cb transcripts <search>Search transcript content
cb transcripts read <ids...>Read full transcripts (max 50)
cb calendarSearch calendar events
cb calendar update <id>Update a calendar event
cb people <names...>Search people by name
cb companies <terms...>Search companies by name or domain
cb emails [search]Search connected email accounts
cb support [search]Search Circleback support articles
cb action-items [search]Search action items
cb action-items create <title>Create an action item
cb action-items update <id>Update an action item
cb action-items delete <id>Delete an action item
cb teamsList your workspace and teams
cb tagsList tags
cb tags create <name>Create a tag
cb tags update <id>Update a tag
cb tags delete <id>Delete a tag
cb foldersList folders
cb folders read <ids...>Read folders
cb folders create <name>Create a folder
cb folders update <id>Update a folder
cb folders delete <id>Delete a folder
cb folders share <id>Share a folder

Run cb --help or cb <command> --help for full usage details.

Meeting identifiers

cb meetings read and cb transcripts read accept up to 50 meeting IDs.

Filtering

Meeting, transcript, and calendar searches support filtering by date range. Meeting and transcript searches also support filtering by tag, person, and company:

cb meetings --tags 1,2 --profiles 42 --domains acme.com
cb meetings --last 30              # Last 30 days
cb meetings --from 2026-01-01 --to 2026-03-01
cb calendar --last 7                # Next 7 days of events

Email search supports inline filter syntax:

cb emails "from:[email protected]"
cb emails "to:[email protected] after:2026-01-01"
cb emails "participant:[email protected] before:2026-06-01"

JSON output

Pass --json to any command to get raw JSON instead of formatted tables. Useful for piping to jq or integrating with other tools:

cb meetings "standup" --json | jq '.[].name'

Login

cb auth login              # Opens your browser to log in
cb auth login --api-key    # Asks for your API key securely
cb auth logout             # Signs out on this device

API-key login links to Settings → API keys, verifies the key, and stores it locally on your device.

For stateless automation, set CIRCLEBACK_API_KEY instead of logging in:

CIRCLEBACK_API_KEY=cb_your_api_key cb meetings --json

Changing meetings, action items, tags, folders, or sharing permissions needs write access. Browser logins from before v0.5.0 don't include it, so run cb auth login again; read-only API keys can't make changes.

An API key limited to one folder only reaches that folder's meetings, transcripts, and action items, so cb --help lists just the commands it can run.

CIRCLEBACK_API_KEY takes precedence over stored credentials. Unset it before running cb auth login; cb auth logout cannot clear an environment variable from your shell.

Agents

The CLI is designed to work well with AI agents and tool-use systems:

  • Every command accepts --json for structured, parseable output
  • Commands follow a consistent <resource> <action> pattern
  • All options have long-form names for clarity
  • Error messages include actionable instructions
  • Exit codes follow standard conventions (0 = success, 1 = error)

版本与发布记录

@circleback/cli 共发布 38 个版本,首次发布于 2026/03/18;过去 12 个月发布了 38 个版本。

版本发布日期距今
1.3.1latest2026/11/072 天前
1.3.02026/11/072 天前
1.2.12026/11/046 天前
1.2.02026/10/319 天前
1.1.12026/10/2219 天前
1.1.02026/10/1030 天前

关于 @circleback/cli 的常见问题

@circleback/cli 是什么?

Circleback CLI. Search and access meetings, emails, calendar events, and more.

如何安装 @circleback/cli?

在项目目录运行 npm install @circleback/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cb、circleback,可以用 npx cb 直接运行。

@circleback/cli 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/circleback__cli 是否存在。

@circleback/cli 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@circleback/cli 可以商用吗?

@circleback/cli 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@circleback/cli 的下载量有多少?

根据 npm 官方下载统计,@circleback/cli 在 2026/10/10 – 2026/11/08 这 30 天内被下载 5,428 次,日均约 181 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@circleback/cli 还在维护吗?

最新版本 1.3.1 发布于 2026/11/07(2 天前);至今共发布 38 个版本,其中过去 12 个月发布了 38 个;首次发布于 2026/03/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。