BB

beakrhub/beakr-cli

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

0 stars 0 forks 质量 79 趋势 20Apache-2.0

为 Beakr 知识库提供 CLI 和 MCP 服务器

概览

为Beakr提供CLI和MCP服务器:团队的知识、项目、文件和集成,无论是终端、脚本还是代理。 CLI和SDK涵盖了Beakr文档化的API,该API刻意设计较小:登录和密钥、组织成员和服务账户、项目、文件、知识(读写、提案、研究)、代理运行、面试、对话、集成以及嵌入模式部分(外部用户、标签、终端用户令牌)。运行beakr——命令帮助;Beakr API每个文档操作只有一个命令。 Beakr 同时发货两个表面,Beakr 安装两个面板。它们包装的是同一个后端。 - (beakr research,beakr kb ...)—— 为你,使用终端或壳脚本。- (beakr mcp)—— 用于 Claude Code 和 Codex。注册后自动启动;助手通过研究、 knowledge_base 和 knowledge_base_write 调用。你不会直接调用。

概述(AI 翻译)

Beakr的CLI和MCP服务器:你的团队 知识、项目、文件和集成,来自终端、脚本或代理。

CLI和SDK涵盖了Beakr文档中的API,而该API刻意设计得很小: 登录和密钥、组织成员和服务账户、项目、文件, 知识(阅读、写作、提案、调研)、代理跑动、面试, 对话、集成以及嵌入模式部分(外部用户, 标签,终端用户令牌)。执行 beakr --help 以获取命令;beakr api 具有 每个已记录操作只需一个指令。

CLI vs MCP — 何时使用哪种

Beakr 同时发送两个表面,beakr setup 安装两个表面。它们包装的是同一个后端。

  • CLI ([beakr research, beakr kb …) — 为您提供,在终端或壳脚本中。
  • MCP 服务器(beakr mcp)——用于 Claude 代码和代码。注册后自动启动;助手通过 research、knowledge_base 和 knowledge_base_write 调用。你不会直接调用它。

如果你只想装一个,也都装——它们不会冲突,MCP服务器是基于同一API的薄包装。

单线安装

(一旦install.thebeakr.com接线,'卷曲-fsSL https://install.

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

beakr-cli

CLI and MCP server for Beakr: your team’s Knowledge, projects, files and integrations, from a terminal, a script, or an agent.

The CLI and SDKs cover Beakr’s documented API, which is deliberately small: sign-in and keys, organization members and service accounts, projects, files, Knowledge (read, write, proposals, research), agent runs, interviews, conversations, integrations, and the embedded-mode pieces (external users, labels, end-user tokens). Run beakr --help for the commands; beakr api has one command per documented operation.

CLI vs MCP — when to use which

Beakr ships both surfaces, and beakr setup installs both. They wrap the same backend.

  • CLI (beakr research, beakr kb …) — for you, in a terminal or shell script.
  • MCP server (beakr mcp) — for Claude Code and Codex. Starts automatically once registered; the assistant calls it through research, knowledge_base, and knowledge_base_write. You don’t invoke it directly.

If you only want one, install both anyway — they don’t conflict and the MCP server is a thin wrapper over the same API the CLI uses.

The MCP server covers Knowledge, research, documents, files, skills and conversations. Interviews, external users, labels and end-user tokens are in the CLI (beakr interviews, beakr external-users, beakr labels, beakr end-user-tokens) and the SDKs, not in the MCP server.

One-line install

curl -fsSL https://raw.githubusercontent.com/BeakrHub/beakr-cli/main/install.sh | sh

(Once install.thebeakr.com is wired up, curl -fsSL https://install.thebeakr.com | sh will work too — same script, prettier URL.)

That’s it. The script:

  1. Installs uv if missing (no system Python required — uv ships its own).
  2. Installs the beakr CLI from GitHub (uv tool install git+https://github.com/BeakrHub/beakr-cli), putting a real beakr binary on PATH at ~/.local/bin/beakr. It needs git. (PyPI’s newest beakr-cli is 0.3.x, which is older than this CLI and talks only to production; install from GitHub until 0.4 is published there.)
  3. Signs you in through the browser, or verifies $BEAKR_API_KEY and saves it to the keychain so Claude Code and Codex can use it.
  4. Registers the Beakr MCP server in Claude Code (claude mcp add or ~/.claude.json) and Codex (~/.codex/config.toml) — whichever it detects — pointing at the beakr that ran setup, with your API URL and BEAKR_HOME when they are not the defaults.
  5. Copies the Beakr skill and kb-* slash commands into ~/.claude and/or ~/.codex.

Restart Claude Code or Codex once and the beakr MCP server appears under /mcp. You can also use the CLI directly: beakr kb search "...", beakr research "...", etc.

Pass flags through the pipe if you want non-interactive behavior:

# Skip the API key prompt (auth later with `beakr auth login`)
在 GitHub 查看完整 README

安装

uvx --from git+https://github.com/BeakrHub/beakr-cli beakr mcp
新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "beakr": { "command": "uvx", "args": ["--from", "git+https://github.com/BeakrHub/beakr-cli", "beakr", "mcp"], "env": { "BEAKR_API_KEY": "<your-key>" } } } }