# @cuongtran001/kanna 中文文档

规范地址：https://npmcn.com/package/%40cuongtran001/kanna/

版本：1\.107\.5
npm 元数据更新时间：2026-11-10T08:18:17.007Z
中文译文更新时间：2026-11-11T04:45:46.713Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cuongtran001/kanna
原文对照：https://npmcn.com/package/%40cuongtran001/kanna/?lang=original
项目主页：https://github.com/cuongtranba/kanna#readme
源码仓库：https://github.com/cuongtranba/kanna

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：31.5 MB，1756 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：72 个
- 首次发布：2026-04-29T04:46:48.681Z
- 最新版本发布：2026-11-10T08:18:16.324Z
- 近 30 天下载量：10872（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：335（近 12 个月 335 个）

## 中文简介

克劳德代码的美丽网络用户界面

## 安装

```sh
npm install @cuongtran001/kanna
```

也可以使用：`pnpm add @cuongtran001/kanna`、`yarn add @cuongtran001/kanna`、`bun add @cuongtran001/kanna`

## README

![Kanna](https://npmcn.com/package/%40cuongtran001/kanna/assets/icon.png)

# 坎纳

**Claude Code和Codex代理商的网络UI,为许多项目的长会所建.**

[![npm version](https://img.shields.io/npm/v/@cuongtran001/kanna.svg?style=flat&colorA=18181b&colorB=f472b6)](https://www.npmjs.com/package/@cuongtran001/kanna) [![npm downloads](https://img.shields.io/npm/dm/@cuongtran001/kanna.svg?style=flat&colorA=18181b&colorB=f472b6)](https://www.npmjs.com/package/@cuongtran001/kanna) [![Release Please](https://github.com/cuongtranba/kanna/actions/workflows/release-please.yml/badge.svg?branch=main)](https://github.com/cuongtranba/kanna/actions/workflows/release-please.yml) [![license](https://img.shields.io/npm/l/@cuongtran001/kanna.svg?style=flat&colorA=18181b&colorB=f472b6)](https://github.com/cuongtranba/kanna/blob/main/LICENSE)

[**文档**](https://kanna-wiki.lowbit.link/) • 妇女 [安装指南](https://kanna-wiki.lowbit.link/getting-started/install/) • 妇女 [更改日志](https://npmcn.com/package/%40cuongtran001/kanna/CHANGELOG.md)

  

![Kanna screenshot](https://npmcn.com/package/%40cuongtran001/kanna/assets/screenshot.png)

## 坎纳是什么

Kanna 运行在您的机器上,并在您已经使用的编码代理前放置了浏览器 UI: Claude Agent SDK, Codex app-server, OpenRouter 模型,以及您注册的任何 Anthropic 兼容的端点. 每一次聊天都属于一个项目,每起事件被保存到磁盘上,UI工作在桌面上,电话上,或者通过隧道.

## 快速启动

```bash
curl -fsSL https://bun.sh/install | bash   # if you don't have Bun 1.3.11+
bun install -g @cuongtran001/kanna
kanna                                       # opens http://localhost:3210
```

添加 Claude OAuth 令牌、 编码登录或 OpenRouter 密钥 **设置 – 供应商**,打开工程文件夹,然后开始聊天。 这个 [安装指南](https://kanna-wiki.lowbit.link/getting-started/install/) 包括要求和旗帜.

## 如何融为一体

![Architecture diagram: the Kanna web app talks to a Bun server over WebSocket; its agent coordinator records every event, runs turns on the Claude Agent SDK or the Codex app-server, and those agents edit your project worktree and call your MCP servers and Kanna's own tools.](https://npmcn.com/package/%40cuongtran001/kanna/assets/diagrams/kanna-architecture.svg)

一个邦程序拥有一切。 浏览器在 WebSocket 上发送命令,代理协调器运行每个打开一个提供者,每个更改在仅附加的事件日志下 `~/.kanna/data`。刷新页面或重新启动服务器,聊天会按原样回来.

## 特征

**与任何代理聊天**

-   **Claude、Codex 和 OpenRouter 软件** 在一个作曲家中,带有每个聊天模式,推理努力和上下文窗口控制. [供应商和模型](https://kanna-wiki.lowbit.link/features/providers-models/)
-   **自定义终点**: 在设置中注册任何 Anthropic 兼容的 API(GLM, Quen, Kimi, DeepSeek, MiniMax, 一个本地的 Ollama),并在作曲中选择其模型. [自定义终点](https://kanna-wiki.lowbit.link/guides/user/custom-endpoints/)
-   **OAuth 符号池**: 注册多个克洛德令牌,而坎纳在它们之间旋转,当一个达到一个速率限制时失败. [OAuth 游泳池](https://kanna-wiki.lowbit.link/getting-started/oauth-pool-setup/)
-   **现场输出**:在Claude Agent SDK上运行的聊天上,思维,文本和工具输入流如模型所写,回复键被打出在护身符后. Codex聊天将计划作为活的任务列表发布.
-   **丰富的记录**: 分组工具调用, 内置 diffs, 计划模式批准, 在您看到它们之前检查过人鱼图, 以及交互式的图表, 报告和流程图 代理制成( )[遗传性UI](https://kanna-wiki.lowbit.link/features/generative-ui/)) (中文(简体) ).
-   **到处都是斜线命令**数字 : `/clear`, (中文(简体) ), `/compact`, (中文(简体) ), `/cron`加上你本地的克洛德密码技术 每个供应商都有. [斜线命令](https://kanna-wiki.lowbit.link/features/slash-commands/)

**趁你不在的时候让它起作用**

![Fan-in diagram: a typed message, a cron job, a loop wake, a background subagent and a board card all enter one durable per-chat queue, which starts a turn only when the chat is idle and writes its output to the transcript.](https://npmcn.com/package/%40cuongtran001/kanna/assets/diagrams/kanna-turn-queue.svg)

-   **副剂**:以自己的提示和工具命名的代理. 主要代理代表,平行运行或背景运行,结果以新的转折回. [副剂](https://kanna-wiki.lowbit.link/guides/user/subagents/)
-   **自动循环**:给出一个入球和一个验证命令;Kanna通过持久任务列表工作,直到检查通过并自行停止. [循环](https://kanna-wiki.lowbit.link/features/loops/)
-   **连续任务**数字 : `/cron` 在同一聊天或新聊天中,将反复出现的指示排到第二个. [连续任务](https://kanna-wiki.lowbit.link/features/cron-jobs/)
-   **持久队列**: 消息, 唤醒并排程在每次聊天的队列中等待, 在服务器重启后幸存下来.
-   **背景任务和工作流程**:dev服务器,长建和克洛德代码工作流程显示活状态,坎纳在运行时保持会话活性.

**组织工作**

![State diagram of a board card: Kanna moves it to In progress on Start work and creates its worktree and chat, the agent advances it one column when the work is verified, and only you move it to Done, which asks whether to merge, discard or keep the worktree.](https://npmcn.com/package/%40cuongtran001/kanna/assets/diagrams/kanna-board-card.svg)

-   **项目和会话标签**: 按项目分组的具有活性状态的聊天, 设置、 Cron、 Workflows、 棋盘和 Webhooks 作为标签打开的一页工作空间, 一个项目快速切换器, 并单击导入现有的 Claude 代码会话 . [项目和会议](https://kanna-wiki.lowbit.link/features/projects-sessions/)
-   **坎班板块**数字 : _开始工作_ 在一张卡片上创建了分行,git工作树和聊天,因此几个特工可以同时工作而不接触对方的文件. 董事会与 GitHub 问题同步 . [董事会](https://kanna-wiki.lowbit.link/features/boards/)
-   **多堆栈**: 组合多个寄存器, 这样一个聊天可以读取并编辑所有寄存器 . [堆栈](https://kanna-wiki.lowbit.link/features/multi-repo-stacks/)

**扩展和连接**

-   **您的 MCP 服务器** (单位:千美元)`stdio`, (中文(简体) ), `http`, (中文(简体) ), `sse`, (中文(简体) ), `ws`,其中OAuth 2.1)在每次聊天中都可以提供. [高级](https://kanna-wiki.lowbit.link/features/advanced/)
-   **Kanna 作为 MCP 服务器**: Claude Code, Codex, Claude Desktop 和 ChatGPT 可以将Kanna本身驱动过MCP. [远程 MCP](https://kanna-wiki.lowbit.link/guides/user/remote-mcp/)
-   **进入的网点**: CI、 GitHub 或一个 `curl` 呼叫可以将卡片寄入聊天,排队提示,或者开始新的聊天. [网络呼号](https://kanna-wiki.lowbit.link/guides/user/webhooks/)
-   **Kanna 插件** 添加边栏页面、面板和 `/` 命令,其服务器半部分在自己的进程中运行. [插件](https://kanna-wiki.lowbit.link/features/plugins/)
-   **灯塔** 配对另一个您拥有的机器, 这样代理可以读取文件或者在您设定的限度内运行命令 . [灯塔](https://kanna-wiki.lowbit.link/guides/user/beacons/)
-   **软件包更新** 对于已安装的技能, Claude 代码插件和 Codex 插件, 请检查并从设置中应用 . [软件包自动更新](https://kanna-wiki.lowbit.link/features/package-auto-update/)

**到处跑**

-   **密码门**、局域网或Tailscale绑定,以及Cloudflare地道(`--share`, (中文(简体) ), `--cloudflared`),外加一个代理工具,根据请求暴露出dev服务器. [自主办](https://kanna-wiki.lowbit.link/guides/ops/self-host/)
-   **只读共享链接** 这使得一个聊天 完全如你所见. [会话份额](https://kanna-wiki.lowbit.link/sharing/session-share/)
-   **可恢复的上传** 用于多吉加比特文件,甚至在隧道请求大小限制之后.
-   **网络推力、PWA安装、电话布局**,可定制的密钥绑定,以及 **正在自动更新** 在pm2下,系统化,多克或平地外壳. [自更新日期](https://kanna-wiki.lowbit.link/guides/ops/self-update/)

## 使用量

```bash
kanna                         # localhost only, opens a browser
kanna --port 4000             # custom port
kanna --remote                # bind 0.0.0.0 (LAN, Tailscale)
kanna --password <secret>     # require a password for the app, WebSocket and API
kanna --share                 # temporary public trycloudflare.com URL + terminal QR
kanna --cloudflared <token>   # run a named Cloudflare tunnel
kanna plugin ls               # manage Kanna plugins
```

`kanna --help` 列出每个旗帜。 国家生活 `~/.kanna`; 备份以保持您的聊天历史. 部署配方 [页:1](https://kanna-wiki.lowbit.link/guides/ops/pm2/), (中文(简体) ), [系统d](https://kanna-wiki.lowbit.link/guides/ops/systemd/), (中文(简体) ), [夹克](https://kanna-wiki.lowbit.link/guides/ops/docker/) (单位:千美元) [云浮隧道](https://kanna-wiki.lowbit.link/guides/ops/cloudflare-tunnel/) 在维基文库中.

## 发展

```bash
git clone https://github.com/cuongtranba/kanna.git && cd kanna
bun install
bun run setup:hooks   # gitleaks + commit-message hooks, once per clone
bun run dev           # Vite client on :5174, server on :5175
bun run check         # lint + types, comments, build
bun run test          # Vitest via vp test, run under Bun
```

开始 [`CLAUDE.md`](https://npmcn.com/package/%40cuongtran001/kanna/CLAUDE.md) 编辑 [贡献指南](https://kanna-wiki.lowbit.link/guides/contributing/overview/)。服务器是事件源代码, IO 被封存在后面 `*.adapter.ts` 文档,并加插门执行两者 [结构页面](https://kanna-wiki.lowbit.link/guides/contributing/architecture/) 解释出形状. 请通过释放来切断释放;见 [释放](https://kanna-wiki.lowbit.link/guides/contributing/releasing/)。 。 。 .

## 文档网站

医生在 [kanna-wiki.lowbit.link (英语)](https://kanna-wiki.lowbit.link/) 是从 [`wiki/`](https://npmcn.com/package/%40cuongtran001/kanna/wiki/) 在这个回放中:一个拥有自己的Astro星光网站 `package.json`,除去根积分,涂料和测试。 每一次推动 `main` 触动 `wiki/**` 重建并部署到 GitHub Pages .

```bash
cd wiki
bun install
bun run dev           # live preview of the docs site
bun run build         # the same build CI deploys
```

页面 `wiki/src/content/docs/`。修改同一 PR 中描述的行为的一页.

这个 [GitHub 维基语录](https://github.com/cuongtranba/kanna/wiki) 是同一个页面生成的镜像,从 `wiki/` 在每次推动 `main` 这触摸它。 编辑 `wiki/`,从未使用 GitHub 维基百科中的相关条目: 下集同步时所做出的修改 。 要预览镜像, 请运行 `bun run export:github-wiki <dir>` 内 `wiki/`。 。 。 .

## 合作伙伴

[内科](https://undercroft.lowbit.link/) 是一个开源的越南第一数据平台(任何 REST 源入一个不可改变的生湖, Postgres, dbt models and BI),其MCP端点Kanna作为MCP客户端连接在OAuth上.

## 恒星历史

[![Star History Chart](https://api.star-history.com/image?repos=cuongtranba/kanna&type=date&legend=top-left)](https://www.star-history.com/?repos=cuongtranba%2Fkanna&type=date&legend=top-left)

## 许可证

[麻省理工学院](https://npmcn.com/package/%40cuongtran001/kanna/LICENSE)

## 常见问题

### @cuongtran001/kanna 是什么？

克劳德代码的美丽网络用户界面

### 如何安装 @cuongtran001/kanna？

在项目目录运行 npm install @cuongtran001/kanna，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 kanna，可以用 npx kanna 直接运行。

### @cuongtran001/kanna 支持 TypeScript 吗？

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

### @cuongtran001/kanna 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cuongtran001/kanna 可以商用吗？

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

### @cuongtran001/kanna 的下载量有多少？

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

### @cuongtran001/kanna 还在维护吗？

最新版本 1\.107\.5 发布于 2026/11/10（今天）；至今共发布 335 个版本，其中过去 12 个月发布了 335 个；首次发布于 2026/04/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

