# @deerdesign/deertools 中文文档

规范地址：https://npmcn.com/package/%40deerdesign/deertools/

版本：1\.3\.0
npm 元数据更新时间：2026-11-03T05:50:38.281Z
中文译文更新时间：2026-11-11T20:44:08.028Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.4 MB，52 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-10-16T21:16:00.464Z
- 最新版本发布：2026-11-03T05:50:38.101Z
- 近 30 天下载量：5197（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 33 个）

## 中文简介

DeerTools CLI:用于DeerTools产品API的开发者认证和AI代理访问(Estimate,Catalog,交付,供应商枢纽,RenderMind,鹿技能)

## 安装

```sh
npm install @deerdesign/deertools
```

也可以使用：`pnpm add @deerdesign/deertools`、`yarn add @deerdesign/deertools`、`bun add @deerdesign/deertools`

## README

# @ deerdesign/ deertools (英语)

> 官方"鹿图"CLI:对"鹿图"产品API的安全,范围认证和AI代理访问.

从您的计算机登录一次, 并允许您的 AI 编码代理( Antigravity, Cursor, Claude Code, Loveable, CLI 代理) 访问 DeerTools APIS **代表您严格按照您的权限范围, 且在 URL 中不显示任何证书**。 。 。 .

### 支持产品

| 产品命令密钥 | 波兰别名 | 名称 | 生产 URL | 说明 |
| :-- | :-- | :-- | :-- | :-- |
| `estimate` | `kosztorys` | 鹿类工具估计 | `https://connect.deerdesign.pl/kosztorys/` | 平面计划PDF分析、厨房区域探测、内部成本估算 |
| `catalog` | `katalog` | 鹿图目录 | `https://connect.deerdesign.pl/katalog/` | 材料目录(Smart/Modern/High Life),类别,产品 |
| `deliveries` | `dostawy` | 鹿工具运送 | `https://ship.deergroup.pl/` | 后勤、现场交货时间表、供应商发货、跟踪 |
| `supplier` | —— 说 | 供应商枢纽 | `https://supplier.deergroup.pl/` | 供应商订单、细列项目、索赔、交货情况 |
| `rendermind` | —— 说 | 发光点 | `https://rendermind.deergroup.pl/` | pCon 3D 渲染管道、 AI 图像生成、 平面图代理 |
| `skills` | `hub`, (中文(简体) ), `skill` | 鹿技能枢纽 | `https://skills.deergroup.pl/` | AI 代理技能与MCP 注册、版本、捆绑与推广工作流程 |

_(两个英文名字都像 `catalog`, (中文(简体) ), `estimate`, (中文(简体) ), `deliveries`, (中文(简体) ), `skills` 和留下的波兰名字,如 `katalog`, (中文(简体) ), `kosztorys`, (中文(简体) ), `dostawy`, (中文(简体) ), `umiejetnosci` 以互换方式支持._

* * *

## 安装

要求数 **节点.js 18**零运行时间依赖.

### 选项1:立即运行 `npx` (不需要安装)

```bash
npx -y @deerdesign/deertools@latest login catalog
```

### 备选方案2:在全球安装

```bash
npm install -g @deerdesign/deertools
```

安装两个 `deertools` 二进制和方便的短名 `deer`数字 :

```bash
deertools --help
# or
deer whoami
```

* * *

## 认证(OAuth 2.1 + PKCE S256)

鹿图斯 CLI 执行官方 **OAuth 2.1 与PKCE的授权代码赠款(RFC 8252,RFC 8414)**数字 :

```bash
# Log in to a single product with read-only access (default):
deertools login catalog

# Log in to other products (in English or Polish):
deertools login estimate         # or: deertools login kosztorys
deertools login deliveries       # or: deertools login dostawy
deertools login supplier
deertools login rendermind
deertools login skills           # or: deertools login hub

# Request read + write scopes:
deertools login catalog --write
deertools login skills --write

# Interactive login across all 6 products sequentially:
deertools login all

# Check current authentication status and expiration:
deertools whoami

# Check status in machine-readable JSON format:
deertools whoami --json

# Revoke local credentials:
deertools logout catalog
```

### 引擎盖下如何运作

1.  **RFC 8414 发现**: CLI 查询 `/.well-known/oauth-authorization-server` 在产品主机上发现授权和符号端点.
2.  **循环服务器**: CLI 启动 ephemeral HTTP 服务器 `127.0.0.1:<random-port>` 并生成加密安全的PKCE代码验证器和S256挑战.
3.  **浏览器同意**:用户默认浏览器打开产品 `/oauth/authorize` 页 次 用户认证(Microsoft SSO / SSO / Magic Link)并批准所请求的范围.
4.  **单一用途授权代码**:浏览器以短寿命的授权代码(60秒TTL)重定向到回路服务器. 查询字符串中从未出现任何密钥或符号 .
5.  **直接汇兑**: CLI 直接发送 `POST` 至产品的符号终点(`/oauth-token`)与代码验证器.
6.  **本地存储**:产品发行了范围化的API密钥(A`deer_<product>_live_...`有效期为90天。 CLI坚持在 `~/.deertools/credentials.json` 带有严格的 POSIX 文件权限(`0600`) (中文(简体) ).

* * *

## AI 代理集成和使用

### 1\. 检查文件和规格

```bash
# Read high-level llms.txt (public overview and authentication instructions):
deertools docs catalog
deertools docs rendermind

# Fetch full OpenAPI 3.0 JSON specification:
deertools docs catalog openapi

# List all available endpoints with required scopes:
deertools endpoints catalog
```

### 2\. Invoke产品 API

CLI 自动处理授权信头, 拒绝对非白名单主机的任何请求 :

```bash
# Call GET endpoint:
deertools api catalog GET /api/v1/products --query category=flooring

# Call POST endpoint with JSON payload:
deertools api rendermind POST /api/v1/visualizations --data '{"prompt":"Modern Scandinavian kitchen"}'

# Read payload from file:
deertools api rendermind POST /api/v1/visualizations --data-file request.json
```

### 3\. 开发者与环境公用事业

DeerTools CLI严格注重认证,远程MCP管弦乐,和DeerSkills Hub管理. 域运算和商业逻辑直接由产品平台(Kosztorys, Katalog, Dostawy, Supper Hub, RenderMind)托管,并通过他们自己的REST API和远程MCP端点访问.

```bash
# 1. Environment & API Doctor:
deertools doctor
deertools doctor --json

# 2. Shell Autocompletion (Zsh, Bash, Fish):
deertools completion install      # automatically configures ~/.zshrc or ~/.bashrc

# 3. BaseLinker Hub & MCP Proxy:
deertools baselinker auth <X-BLToken>           # Save BaseLinker token to credentials.json
deertools baselinker test                       # Test authorization and list product catalogs
deertools baselinker serve --port 3456          # Launch local Web UI dashboard + MCP SSE server
deertools baselinker mcp                        # Stdio MCP bridge (Cursor / Claude Desktop)
deertools baselinker sync-schema                # Download and refresh 204 API methods from api.baselinker.com
deertools baselinker search "relations"         # Search BaseLinker methods and parameter schemas
deertools baselinker call getOrders             # Direct API method execution from terminal
deertools baselinker catalog search 105 "oak"   # Search products in BaseLinker catalog

# 4. Local Stdio MCP Bridge (for Claude Desktop, Ollama, local LLM tools):
deertools mcp serve

# 5. Audit Log:
deertools audit --limit 25
deertools audit --clear

# 6. Multi-Profile Management:
deertools profile list
deertools profile use staging

# 7. AI Agent Skills (DeerSkills Hub):
deertools skill list                         # View list of skills with installation status across agents
deertools skill sync                         # Pull and update skills from Hub (protects local changes)
deertools sync --push                        # Full two-way sync: pull updates + push newer local skills to Hub
deertools skill install --all                # Alias for skill sync (full team synchronization)
deertools skill install deer-kosztorys       # Install specific skill to detected AI agent environments
deertools skill install deer-kosztorys --version 1.0.0
deertools skill search "pricing"             # Search skills by keyword, tag, or description
deertools skill push ./my-skill              # Publish new version with automated secret scanning
deertools skill push ./my-skill --tags "pricing, margins, design" # Attach tags upon publish
deertools skill push ./my-skill --team architects # Publish directly to specific team space
deertools skill share my-skill --team architects   # Share private skill with team members
deertools skill share my-skill --private           # Revoke sharing (private to author only)
deertools skill update deer-kosztorys        # Update installed skill to latest Hub version
deertools skill update                       # Update all installed skills across agents
deertools skill promote my-skill             # Submit promotion request to company-wide global registry

# 8. Team Management:
deertools team list                          # List teams, member counts, and assigned skills
deertools team members architects            # List members and roles in the architects team
deertools team add architects john@deer.pl   # Add user to team (member role)
deertools team add architects eva@deer.pl --role lead # Add team lead
deertools team remove architects john@deer.pl # Remove member from team
deertools team create "Interior Designers" --slug designers # Create new organization team

# 9. AI Agent MCP Registry & Configuration:
deertools mcp list                           # List available MCP servers across the ecosystem
deertools mcp config                         # Print JSON MCP configuration for manual pasting
deertools mcp install                        # Automatically write & update MCP config across ALL 7 agent targets
deertools doctor                             # Verify MCP connectivity, auth tokens and client config files
```

* * *

## AI 代理 MCP 配置和工具化( Cursor, Antigravity, Claude)

`@deerdesign/deertools` 提供7个官方MCP服务器,覆盖完整的"鹿"设计生态系统:

1.  `deer-estimate`:平面计划PDF分析,厨房检测,内部成本计算.
2.  `deer-catalog`:17k+ 完成材料(Smart/Modern/High Life),技术规格,过滤.
3.  `deer-deliveries`:站点交货跟踪,供应商发货,仓库WZ生成.
4.  `deer-supplier`:供应商订单,购买折扣,销售加价,商业条件.
5.  `deer-rendermind`: 内部渲染,pCon CAD可视化,产品相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相.
6.  `deer-baselinker`:完整 BaseLinker目录 CRUD,定价批次更新,智能快取.
7.  `deer-skills`: 鹿技能 枢纽登记、技能搜索、下载和审查管道.

### 1\. 自动零配置设置(建议)

您不需要手动编辑 JSON 文件 。 仅登录或运行 :

```bash
deertools login all    # Automatically logs in and syncs MCP configs across all clients
# or at any time:
deertools mcp install  # Re-generates and writes configuration to all 7 targets
```

`deertools mcp install` 自动发现并写入所有7个支持的AI环境:

| 目标环境 | 配置路径 | 支持的工具 |
| :-- | :-- | :-- |
| **工作空间标准** | `<project-root>/.mcp.json` | Claude Code, Claude 桌面合作, Windsurf, Zed |
| **克劳德桌面( MacOS)** | `~/Library/Application Support/Claude/claude_desktop_config.json` | Claude 桌面本地MCP |
| **Claude 代码 CLI** | `~/.claude.json` | Claude 代码终端助理 |
| **光标 IDE( 全球)** | `~/.cursor/mcp.json` | 光标代理( C) |
| **光标工作空间** | `<project-root>/.cursor/mcp.json` | 光标工程范围 |
| **反重力工作空间** | `<project-root>/.agents/mcp_config.json` | Google 反重力/双子星代理 |
| **全球反重力** | `~/.gemini/config/mcp_config.json` | 谷歌反重力全球简介 |

随时用 :

```bash
deertools doctor
```

* * *

### 2\. 手工配置和克洛德整合细节

如果手动配置或添加到已有设置中 :

#### A. 项目一级 `.mcp.json` (为克洛德代码和同事推荐)

创建或编辑 `.mcp.json` 在您的工程根中 :

```json
{
  "mcpServers": {
    "deer-rendermind": {
      "command": "/Users/<your-user>/.local/bin/deertools",
      "args": ["rendermind", "mcp"],
      "env": {
        "PATH": "/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Users/<your-user>/.local/bin"
      }
    },
    "deer-baselinker": {
      "command": "/Users/<your-user>/.local/bin/deertools",
      "args": ["baselinker", "mcp"],
      "env": {
        "PATH": "/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Users/<your-user>/.local/bin"
      }
    },
    "deer-catalog": {
      "url": "https://ftzaobeixglnssemugjf.supabase.co/functions/v1/catalog-mcp",
      "headers": {
        "x-api-key": "<your-catalog-key>",
        "Authorization": "Bearer <your-catalog-key>"
      }
    },
    "deer-estimate": {
      "url": "https://vlemuxlubrowuuxpgllk.supabase.co/functions/v1/estimate-mcp",
      "headers": {
        "x-api-key": "<your-estimate-key>",
        "Authorization": "Bearer <your-estimate-key>"
      }
    }
  }
}
```

> \[大 **Claude 桌面和 Claude 代码的关键规则 :**
> 
> 1.  **在macOS上选择继承**: 桌面图形用户界面应用程序( 如 Claude 桌面) 不继承您的终端外壳 `$PATH` (单位:千美元)`~/.local/bin`, (中文(简体) ), `/usr/local/bin`) (中文(简体) ). 总是指定绝对二进制路径(例如. `~/.local/bin/deertools`并包括 `env.PATH` 如上所示的块 `node` 并且儿童过程可以不犯错误地产生.
> 2.  **项目信任对话框**: 在项目一级打开工作空间时 `.mcp.json`,克洛德显示安全同意的提示(_"所有MCP服务器 从.mcp.json?"_) (中文(简体) ). 您必须点击 **允许/ 总是允许** 以激活工具.
> 3.  **需要恢复会话**: MCP 服务器工具在对话会话初始化时严格注册. 如果您在会话已激活时配置 MCP, 请启动 **新建聊天( N)`Cmd + N`(中文(简体) )** 或重新启动 Claude 应用程序(`Cmd + Q`) MCP 工具不能被热重装入持续的对话中.

* * *

## BaseLinker MCP 代理和目录管理

`@deerdesign/deertools` 包括内置、本地 **碱克 MCP 代理控件( H)** 提供深层目录管理:

1.  **产品目录和变量**数字 :
    -   `bl_catalog_get_product`: 有描述,特征,频道特有介质,捆绑和关系的详细产品数据.
    -   `bl_catalog_create_or_update_product`: 使用 SKU, EAN, 税率, 尺寸, 重量, 制造商, 类别创建或更新产品.
    -   `bl_catalog_search_products`:按名称、SKU、EAN、类别或制造商过滤产品.
2.  **关系和交叉销售**数字 :
    -   `bl_catalog_set_relations`:建立产品关系(`related`, (中文(简体) ), `substitution`, (中文(简体) ), `upsell`, (中文(简体) ), `downsell`, (中文(简体) ), `crosssell`) (中文(简体) ).
3.  **产品特性自定义文本字段( C)**数字 :
    -   `bl_catalog_set_descriptions_and_features`: 更新描述和密钥值参数地图(`features`每个语言.
4.  **媒体和图像收藏**数字 :
    -   `bl_catalog_manage_images`: 在0–15位置上添加图像 URL / Base64,替换相片,或清晰位置.
5.  **类别、制造商和标签**数字 :
    -   `bl_catalog_categories`, (中文(简体) ), `bl_catalog_manufacturers`, (中文(简体) ), `bl_catalog_tags`: 全 CRUD 用于组织分类.
6.  **大宗价格和股票更新**数字 :
    -   `bl_catalog_update_prices_batch` 打开 `bl_catalog_update_stock_batch`:每个呼叫最多可更新1000个项目.
7.  **费率限制和安全性**数字 :
    -   内置活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活性活.
8.  **现场网络盘**数字 :
    -   运行 `deertools baselinker serve` 打开本地网络用户界面 `http://localhost:3456` 和代理审计流.

* * *

## 鹿技能枢纽和MCP生态系统

**鹿技能枢纽** (单位:千美元)`https://skills.deergroup.pl`)是跨"鹿"设计生态系统分布,版本,管理AI Agent Swills和MCP服务器的中心平台:

1.  **三Tier 范围与权限模型**数字 :
    -   **公司技能`global`(中文(简体) )**:经验证的全组织性工具,所有员工可见,代理初始化期间默认安装.
    -   **团队范围技能(`team`(中文(简体) )**:专为特定功能团队(如:建筑师,销售顾问,估算师,物流,IT-Dev). 可见和可安装 **严格** 由该团队的成员。 团队和角色完全可以通过 `deertools team` 和网络门户.
    -   **个人技能`user`(中文(简体) )**:每个雇员都可以在个人姓名空间发表 `@username/skill-slug`在提交人明确与他们的团队分享之前,这些保留是100%的私人保留(第3条)`deertools skill share --team <slug>`)或将其提交全球推广(`deertools skill promote`) (中文(简体) ).
2.  **自动秘密扫描仪**数字 :
    -   每个 `deertools skill push` 运行一个全程的regex扫描仪,用于活符和API密钥(`deer_*_live_`, (中文(简体) ), `ghp_`, (中文(简体) ), `sk-`, (中文(简体) ), `X-BLToken`,密码).
    -   任何未删减的秘密都会引发直接的安全中止,并带有特定的线条引用,防止上传前的证书泄漏.
3.  **SemVer 版本和视觉 Diff**数字 :
    -   所有修订都遵循语义版(`1.0.0` - > (中文) `1.0.1` - > (中文) `1.1.0`) (中文(简体) ).
    -   网页门户有一个交互的相邻视觉 diff 比较文件树和 `SKILL.md` 内容介于发布之间.
    -   CLI 支持 `--bump patch|minor|major` 或明确的版本旗帜.
4.  **跟踪`.deertools-lock.json`(中文(简体) )**数字 :
    -   安装后的技能在当地跟踪 `.deertools-lock.json` 并安装了时间戳.
    -   `deertools doctor` 财务报告和审定财务报表 `deertools skill check` 检测过时的技能,并及时自动更新.
5.  **促销管道 ("提名全球")**数字 :
    -   作者可以通过下列方式向官方公司目录宣传个人或团队技能: `deertools skill promote <slug>`。 。 。 .
    -   管理员在管理仪表板上审查同行请求,并一击批准.
6.  **AI 代理工具集成(课程/反重力/克洛德)**数字 :
    -   DeerSkills Hub 曝光专用远程MCP服务器(`https://skills.deergroup.pl/functions/v1/skills-mcp`)符合MCP 2024-11-05标准.
    -   工具包括: `hub_search_skills`, (中文(简体) ), `hub_get_skill`, (中文(简体) ), `hub_publish_skill_version`, (中文(简体) ), `hub_list_mcp_servers`, (中文(简体) ), `hub_get_ecosystem_products`。 。 。 .

* * *

## 无头 & CI/CD 环境

在没有浏览器交互的CI管道或容器化剂中,通过环境变量提供API密钥:

```bash
export DEERTOOLS_CATALOG_KEY="deer_catalog_live_..."       # or DEERTOOLS_KATALOG_KEY
export DEERTOOLS_ESTIMATE_KEY="deer_kosztorys_live_..."    # or DEERTOOLS_KOSZTORYS_KEY
export DEERTOOLS_DELIVERIES_KEY="deer_dostawy_live_..."    # or DEERTOOLS_DOSTAWY_KEY
export DEERTOOLS_SUPPLIER_KEY="deer_supplier_live_..."
export DEERTOOLS_RENDERMIND_KEY="deer_rendermind_live_..."

# Custom credentials directory:
export DEERTOOLS_HOME="/custom/path/.deertools"
```

* * *

## 退出代码

| 代码 | 含义 |
| :-- | :-- |
| `0` | 成绩 |
| `1` | 请求或API失败( 如 HTTP 4xx, 5xx) |
| `2` | 无效的 CLI 参数或使用语法 |
| `3` | 缺少或过期的证书(运行) `deertools login`(中文(简体) ) |
| `4` | 缺少 OpenAPI 光谱、 文档或主机解析错误 |

* * *

## 开发和测试

DeerTools CLI是用纯,无依赖的现代节点来写成的.js使用内置模块(`node:crypto`, (中文(简体) ), `node:http`, (中文(简体) ), `node:fs`, (中文(简体) ), `node:test`) (中文(简体) ).

```bash
# Run test suite:
npm test
```

## 许可证

麻省理工学院鹿设计AI团队

## 常见问题

### @deerdesign/deertools 是什么？

DeerTools CLI:用于DeerTools产品API的开发者认证和AI代理访问\(Estimate,Catalog,交付,供应商枢纽,RenderMind,鹿技能\)

### 如何安装 @deerdesign/deertools？

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

### @deerdesign/deertools 支持 TypeScript 吗？

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

### @deerdesign/deertools 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @deerdesign/deertools 需要什么版本的 Node\.js？

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

### @deerdesign/deertools 可以商用吗？

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

### @deerdesign/deertools 的下载量有多少？

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

### @deerdesign/deertools 还在维护吗？

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

