# @jetcrab/pi-desk 中文文档

规范地址：https://npmcn.com/package/%40jetcrab/pi-desk/

版本：1\.1\.33
npm 元数据更新时间：2026-11-01T04:59:45.503Z
中文译文更新时间：2026-11-01T13:30:01.930Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：49.4 MB，1989 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.19\.0
- 运行依赖：43 个
- peer 依赖：@earendil-works/pi-coding-agent \*
- 首次发布：2026-10-08T09:42:18.116Z
- 最新版本发布：2026-11-01T04:59:45.368Z
- 已发布版本数：38（近 12 个月 38 个）

## 中文简介

Pi Desk Web服务的Pi编码代理

## 安装

```sh
npm install @jetcrab/pi-desk
```

也可以使用：`pnpm add @jetcrab/pi-desk`、`yarn add @jetcrab/pi-desk`、`bun add @jetcrab/pi-desk`

## README

# Pi Desk

[English](https://npmcn.com/package/%40jetcrab/pi-desk/README.md) | **简体中文**

> Pi Desk 坚持简单、轻量。模型迭代很快，能力也在持续增强。我相信，越来越多的复杂工作将由一个更强的模型直接完成。Agent 应保持轻量，减少额外上下文与引导提示词，只保留项目必要的规范；子代理保持轻量、按需使用，避免复杂的团队编排。

面向浏览器、桌面和手机的 Pi 编程代理客户端。

[官网](https://pidesk.dev/) · [使用文档](https://pidesk.dev/docs/) · [上游 Pi](https://github.com/earendil-works/pi)

Pi Desk 是 [Pi](https://github.com/earendil-works/pi) 的可视化单用户客户端。你可以同时查看多个会话，预览项目文件与 Git 变更，也可以从另一台设备连接同一个 Pi Desk 服务，接着处理手头的工作。

Pi 负责代理运行，Pi Desk 提供围绕它的工作界面。核心保持轻量，需要的能力通过插件扩展。

## 主要功能

-   **多个会话，并排查看。** 固定会话，对照消息与结果，减少来回切换。
-   **文件与 Git 随手查看。** 在对话旁边预览项目文件、查看变更和提交历史。
-   **不同设备，接着工作。** 使用浏览器，或通过桌面和手机客户端连接同一个服务，查看进度、继续对话。
-   **任务与结果集中呈现。** 通过相应插件，在任务中心跟踪后台命令和子代理，并预览交付物。
-   **按自己的需要扩展。** 使用 Pi Desk 插件和公共 SDK 添加工具、面板、应用及自定义消息视图。

## 界面预览

以下展示 Pi Desk 的常用界面；具体外观随版本与主题变化，点击截图可查看大图。

| 文件预览 | 多会话并排 |
| --- | --- |
| [![文件预览](https://npmcn.com/package/%40jetcrab/pi-desk/docs/doc_asset/client-overview.webp)](https://npmcn.com/package/%40jetcrab/pi-desk/docs/doc_asset/client-overview.webp) | [![多会话并排](https://npmcn.com/package/%40jetcrab/pi-desk/docs/doc_asset/multi-window.webp)](https://npmcn.com/package/%40jetcrab/pi-desk/docs/doc_asset/multi-window.webp) |

在 [pidesk.dev](https://pidesk.dev/) 查看产品演示，在[使用文档](https://pidesk.dev/docs/)中了解具体操作。

## 快速开始

### 环境要求

-   Node.js **22.19.0 或以上**。
-   npm（随 Node.js 安装）。
-   兼容的全局 Pi 安装。

如果尚未安装兼容的 Pi：

```bash
npm install -g --ignore-scripts @earendil-works/pi-coding-agent
npm install -g --ignore-scripts @earendil-works/pi-coding-agent --registry=https://mirrors.cloud.tencent.com/npm # 中国用户可改用这个加速下载
```

开始对话前，请在 Pi 中配置模型服务和账号，操作方式见 [Pi 配置指南](https://pi.dev/docs/latest)。没有配置模型时也可以打开客户端，但不能进行模型对话。

### 通过 npm 运行

使用 npx 直接运行：

```bash
npx @jetcrab/pi-desk
npx --registry=https://mirrors.cloud.tencent.com/npm @jetcrab/pi-desk # 中国用户可改用这个加速下载
```

也可以全局安装，方便后续启动：

```bash
npm install -g @jetcrab/pi-desk
npm install -g @jetcrab/pi-desk --registry=https://mirrors.cloud.tencent.com/npm # 中国用户可改用这个加速下载
pi-desk
```

打开 **[http://localhost:6233](http://localhost:6233/)**。

## 应用

Web 服务负责运行 Pi 会话，浏览器、桌面和手机客户端连接同一个服务。

| 应用 | 源码 | 用途 |
| --- | --- | --- |
| Web 服务 | [`src/`](https://npmcn.com/package/%40jetcrab/pi-desk/src) 与 [`bin/`](https://npmcn.com/package/%40jetcrab/pi-desk/bin) | 浏览器客户端与 Pi 集成 |
| Windows | [`apps/desktop/`](https://npmcn.com/package/%40jetcrab/pi-desk/apps/desktop) | Tauri 桌面壳 |
| macOS（实验性） | [`apps/desktop/`](https://npmcn.com/package/%40jetcrab/pi-desk/apps/desktop) | Tauri 桌面壳 |
| Android | [`apps/android/`](https://npmcn.com/package/%40jetcrab/pi-desk/apps/android) | 连接 Pi Desk 的原生 Android 客户端 |
| iOS（实验性） | [`apps/ios/`](https://npmcn.com/package/%40jetcrab/pi-desk/apps/ios) | SwiftUI / WKWebView 客户端 |
| 隧道 | [`apps/tunnel/`](https://npmcn.com/package/%40jetcrab/pi-desk/apps/tunnel) | Rust TCP 隧道服务与客户端 |

> macOS 和 iOS 客户端目前为实验性支持，尚未纳入稳定版本。作者没有 Mac 和 iOS 设备，未进行实机验证，可能无法正常使用。

## 插件与 SDK

本仓库包含公共 SDK 和九个插件项目。每个插件都是独立包，你可以按需要选择能力，不必把所有功能都加入核心。

| 包 | 用途 |
| --- | --- |
| **[@jetcrab/pi-desk-sdk](https://npmcn.com/package/%40jetcrab/pi-desk/plugins/pi-desk-sdk)** | 宿主接口、插件声明和 Browser Host Runtime |
| **[@jetcrab/pi-desk-bg-run](https://npmcn.com/package/%40jetcrab/pi-desk/plugins/pi-desk-bg-run)** | 后台命令、日志与任务中心集成 |
| **[@jetcrab/pi-desk-subagent](https://npmcn.com/package/%40jetcrab/pi-desk/plugins/pi-desk-subagent)** | 子代理执行与任务中心集成 |
| **[@jetcrab/pi-desk-deliverables](https://npmcn.com/package/%40jetcrab/pi-desk/plugins/pi-desk-deliverables)** | 交付物预览 |
| **[@jetcrab/pi-desk-usage](https://npmcn.com/package/%40jetcrab/pi-desk/plugins/pi-desk-usage)** | 模型用量与费用分析 |
| **[@jetcrab/pi-desk-ctx](https://npmcn.com/package/%40jetcrab/pi-desk/plugins/pi-desk-ctx)** | 上下文管理与历史工具结果回查 |
| **[@jetcrab/pi-desk-quota-viewer](https://npmcn.com/package/%40jetcrab/pi-desk/plugins/pi-desk-quota-viewer)** | 模型服务额度查看 |
| **[@jetcrab/pi-desk-tibo-monitor](https://npmcn.com/package/%40jetcrab/pi-desk/plugins/pi-desk-tibo-monitor)** | Tibo 动态与通知 |
| **[@jetcrab/pi-desk-tool-reason](https://npmcn.com/package/%40jetcrab/pi-desk/plugins/pi-desk-tool-reason)** | 工具调用理由 |
| **[@jetcrab/pi-desk-remote-debug](https://npmcn.com/package/%40jetcrab/pi-desk/plugins/pi-desk-remote-debug)** | 开发页面远程调试 |

插件和 SDK 的更多介绍见[插件概览](https://npmcn.com/package/%40jetcrab/pi-desk/plugins/README.md)。公开 npm 包使用 `@jetcrab/` 命名空间和 npmjs 源。

## 访问与权限

Pi Desk 是具有文件访问、命令执行和插件执行能力的**单用户工具**，不提供多租户执行隔离。

首次启动未配置登录保护时，任何能够访问服务的人都能使用客户端。向他人开放访问前，请在 **设置 → 登录保护** 中设置密码；通过公网访问时使用 HTTPS。

认证数据保存在使用者自己的 Pi Agent 目录，不属于源码仓库。

## 从源码运行

先安装 pnpm，再执行：

```bash
git clone https://github.com/JetCrab/pi-desk.git
cd pi-desk
pnpm install --frozen-lockfile --registry=https://registry.npmjs.org
pnpm install --frozen-lockfile --registry=https://mirrors.cloud.tencent.com/npm # 中国用户可改用这个加速下载
pnpm dev
```

打开 [http://localhost:6233](http://localhost:6233/)。首次访问需要编译页面，可能稍慢。

## 致谢

Pi Desk 基于 earendil-works 的可扩展编程代理框架 [Pi](https://github.com/earendil-works/pi) 构建。感谢 Pi 的维护者和贡献者提供代理运行时与基础库，让这个客户端成为可能。

## 许可证

Pi Desk 自有代码采用 [Apache-2.0](https://npmcn.com/package/%40jetcrab/pi-desk/LICENSE)。第三方代码保留原有许可证、版权声明和来源说明。

## 常见问题

### @jetcrab/pi-desk 是什么？

Pi Desk Web服务的Pi编码代理

### 如何安装 @jetcrab/pi-desk？

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

### @jetcrab/pi-desk 支持 TypeScript 吗？

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

### @jetcrab/pi-desk 需要什么版本的 Node\.js？

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

### @jetcrab/pi-desk 可以商用吗？

@jetcrab/pi-desk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @jetcrab/pi-desk 还在维护吗？

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

