# @2kw/ai 中文文档

规范地址：https://npmcn.com/package/%402kw/ai/

版本：8\.2\.1
npm 元数据更新时间：2026-11-09T20:13:30.177Z
中文译文更新时间：2026-11-09T20:14:10.402Z
软件包许可：SEE LICENSE IN LICENSE

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

原始 npm 页面：https://www.npmjs.com/package/%402kw/ai
原文对照：https://npmcn.com/package/%402kw/ai/?lang=original
项目主页：https://2kw.ai/

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

- 包体积（解压后）：748 kB，193 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.20\.8
- 运行依赖：11 个
- 首次发布：2026-04-26T17:40:11.799Z
- 最新版本发布：2026-11-09T20:13:29.972Z
- 近 30 天下载量：10794（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：196（近 12 个月 196 个）

## 中文简介

2kw.ai的 CLI — schema驱动的文档提取,一个兼容OpenAI的欧盟LLM网关,转录,提示,数据集,以及来自您终端或代理工作流程的实验. 船身为2kw,骨干和bb.

## 安装

```sh
npm install @2kw/ai
```

也可以使用：`pnpm add @2kw/ai`、`yarn add @2kw/ai`、`bun add @2kw/ai`

## README

# 2千瓦CLI( 2kw.ai CLI)

命令行接口 [2kw.ai (英语)](https://2kw.ai/) ——由欧盟主办的AI集成平台. 运行 [策略驱动的文档提取](https://2kw.ai/extraction),路由 LLM 调用 [OpenAI 兼容网关](https://2kw.ai/gateway),转录音频,并管理提示,数据集,以及实验——从终端或内部代理工作流程.

安装三个等同的二进制 : `2kw`, (中文(简体) ), `backbone`,以及 `bb`。 。 。 .

## 安装

```bash
# Latest stable release
npm install -g @2kw/ai

# Pre-release (dev channel)
npm install -g @2kw/ai@dev
```

CLI 更新版本时通知您 .

## 快速启动

```bash
# Authenticate — opens your browser, no API key needed (7-day free trial)
2kw auth login

# Define a schema and run an extraction
2kw schemas create -n "Invoice"
2kw extractions create --schema <id> -m gpt-4o --text "Invoice #123, Total: €500"

# Convert and transcribe
2kw convert file report.docx --format md
2kw transcribe call.mp3 --format srt

# Chat through the gateway
2kw ai chat -m gpt-4o --message "Draft a summary of this quarter's extraction volume"
```

所有命令都与 `bb` 用于快速访问——例如:. `bb schemas list`。 。 。 .

## 认证

通过浏览器签名( 建议) :

```bash
2kw auth login
```

这打开了您的浏览器, 要求您确认一个短代码, 并签名 CLI 在您的用户账户中——没有 API 密钥可以复制。 您的会期为7天 在继续使用CLI的同时,不活动并自我更新. 如果你是属于 您在登录时选择了多个组织, 并且可以随时切换 `2kw context set-org` - 不需要重新登记. `2kw auth logout` 清除当地 证书并签名会话出服务器侧( 最佳效果) .

用于 CI 、 脚本或空接机, 可存储 Org API 密钥 (在设置下创建 ~ 在网络应用中的 API 密钥 ) :

```bash
2kw auth login --api-key sk_...   # save a key directly
2kw auth login --manual           # prompted setup (legacy flow)
```

明确 API 密钥总是优先于存储的浏览器会话 (最高优先):

| 方法 | 示例 |
| --- | --- |
| CLI 旗帜 | `--api-key sk_... --base-url https://...` |
| 环境变量 | `AI_2KW_API_KEY`, (中文(简体) ), `AI_2KW_BASE_URL` (遗产: `BACKBONE_*`(中文(简体) ) |
| 当地 `.2kw` 文件 | 当前目录中的 JSON 文件( legacy : `.backbone`(中文(简体) ) |
| 配置存储 | 设定通过 `2kw auth login` (浏览器会话或保存密钥) |

```bash
2kw auth status    # Verify credentials (works for both auth types)
2kw auth logout    # Clear credentials and send a server-side sign-out
```

说明: `config get apiKey --json` 返回被遮蔽的值——存储的机密 默认情况下不是绕行通过 stdout 。 需要原始密钥通过的脚本 `--reveal` (单位:千美元)`config get apiKey --reveal`)或使用 `AI_2KW_API_KEY`。 。 。 .

## 背景情况

kubectl 风格的环境在组织与环境之间切换:

```bash
2kw context list              # List all contexts
2kw context use acme-corp     # Switch active context
2kw context create staging --base-url https://api.staging.example   # Create a context, sign in through the browser
2kw context create ci --api-key sk_...   # Or store an API key instead
```

`2kw config set memory true` 使 API- key 上下文发送 `X-Backbone-Memory: enabled` 打开 `ai respond` 财务报告和审定财务报表 `agents run` 电话,它选择这些 进入代理内存; `AI_2KW_MEMORY=true|false` 超过每个外壳。 从浏览器- 日志( 会话) 上下文运行, 无论设置如何, 总是符合代理内存的条件, 所以 `memory false` 只影响 API- key 上下文.

## 图标

| 命令 | 说明 |
| --- | --- |
| `auth` | 登录、 登录和检查认证状态 |
| `config` | 获取、设置和列表配置值 |
| `context` | 管理多个类群/环境的背景 |
| `schemas` | 管理计划、版本、标签、验证和测试 |
| `prompts` | 版本的即时管理、标签、汇编、测试 |
| `extractions` | 创建提取( 文本、 文件、 图像)、 列表、 重运行、 估计符号) |
| `convert` | 将 PDF、DOCX、XLSX、图像和20+格式转换为 Markdown/text/HTML/JSON |
| `ai` | 通过OpenAI兼容网关聊天完成、答复(代理或直接模式)和模式上市 |
| `transcribe` | 转录音频( FLAC, MP3, MP4, OGG, WAV, WebM) |
| `datasets` | 为评价建立数据集和数据集版本 |
| `experiments` | 对照数据集运行实验 |
| `evaluators` | 管理评价模板 |
| `scores` | 记录和检查质量分数 |
| `tracing` | 检查请求跟踪和追踪设置 |
| `memory` | 您的代理内存文件( 列表、 读取、 写入、 删除、 忘记); 成员总数和管理员的消除 |
| `providers` | 管理 BYOK AI 提供者 |
| `analytics` | 用法分析:操作、指使、质量、提供者、出错 |
| `billing` | 检查订阅级别和使用限制 |
| `agents` | 运行代理并回答暂停运行(批准和中继工具呼叫); 应用,导出和脚手架代理. Yaml; 管理版本、标签、批准和工具目录 |
| `skills` | 导入并导出 SKILL.md 捆绑; 管理技能版本和标签 |
| `plugins` | 安装插件寄存器、同步并检查其报告 |
| `conversations` | 创建和管理对话框及其项目 |
| `knowledge` | 管理知识库、文件、搜索和引用 |
| `files` | 上传、下载和管理文件 |
| `installations` | 管理地表装置、密钥、来源和配对 |
| `docs` | 从终端浏览 API 文档 |

### 全球选项

| 旗帜 | 说明 |
| --- | --- |
| `--api-key <key>` | 覆盖 API 密钥 |
| `--base-url <url>` | 覆盖基础 URL( 默认为 2kw.ai 云 API) |
| `--json` | 输出原始的 JSON 而不是格式化的表格——用于脚本和代理 |
| `--no-color` | 禁用彩色输出 |

## 为什么是2kw.ai

-   **欧盟数据居住情况** 由Manfred Kunze Development GmbH(德国)运营的符合GDPR的内置模型和欧盟托管的模型
-   **底分数** ——每一个取出的价值链接回溯到源文件的出处
-   **一个平台** 网关、取出、抄录和可观察性共用一个API和一个账单

## 相关

-   [2kw.ai (英语)](https://2kw.ai/) ——平台概况和定价
-   [文档](https://docs.2kw.ai/) 完全命令和API 参考
-   [`@2kw/ai-mcp-server`](https://www.npmjs.com/package/@2kw/ai-mcp-server) 用于 Claude 代码、 Cursor 和 Windsurf 的 2kw.ai MCP 服务器

## 许可证

专有——见 [自由主义](https://npmcn.com/package/%402kw/ai/LICENSE) 详细情况.

## 常见问题

### @2kw/ai 是什么？

2kw\.ai的 CLI — schema驱动的文档提取,一个兼容OpenAI的欧盟LLM网关,转录,提示,数据集,以及来自您终端或代理工作流程的实验\. 船身为2kw,骨干和bb\.

### 如何安装 @2kw/ai？

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

### @2kw/ai 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @2kw/ai 支持 ESM 还是 CommonJS？

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

### @2kw/ai 需要什么版本的 Node\.js？

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

### @2kw/ai 可以商用吗？

@2kw/ai 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @2kw/ai 的下载量有多少？

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

### @2kw/ai 还在维护吗？

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