beakrhub/beakr-cli

Developer tools

Эта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал

0 stars 0 forks Качество 79 Тренд 20Apache-2.0

Repository Install

CLI and MCP server for Beakr's knowledge base

Обзор

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. Beakr ships both surfaces, and beakr setup installs both. They wrap the same backend. - (beakr research, beakr kb …) — for you, in a terminal or shell script. - (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.

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:

Installs uv if missing (no system Python required — uv ships its own).
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.)
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.
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.
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`)

Открыть полный README на GitHub

Установка

uvx --from git+https://github.com/BeakrHub/beakr-cli beakr mcp

Новичок в MCP? Начните с руководства на mcpskill.org →

Конфигурация

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