# @fungi\.computer/inkcap 中文文档

规范地址：https://npmcn.com/package/%40fungi.computer/inkcap/

版本：0\.14\.6
npm 元数据更新时间：2026-11-15T21:58:58.956Z
中文译文更新时间：2026-11-15T18:43:11.113Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：15 MB，425 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：16 个
- 首次发布：2026-10-16T18:05:27.214Z
- 最新版本发布：2026-11-15T21:58:58.773Z
- 近 30 天下载量：9824（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：59（近 12 个月 59 个）

## 中文简介

墨盒: 编辑您计算机上的文件, 牡蛎的 App

## 安装

```sh
npm install @fungi.computer/inkcap
```

也可以使用：`pnpm add @fungi.computer/inkcap`、`yarn add @fungi.computer/inkcap`、`bun add @fungi.computer/inkcap`

## README

# 墨盖( I)`@fungi.computer/inkcap`(中文(简体) )

墨卡普编辑您的计算机上的文件: 文件探索器、 标签和代码编辑器 在浏览器中.

![Inkcap with the koi-pond project open in the explorer and src/fish.ts in the editor beside README.md](https://npmcn.com/package/%40fungi.computer/inkcap/docs/media/editor.png)

墨卡普是一个启动 Apps of [牡蛎](https://github.com/fungi-computer/oyster),打开运行的 App 主机 在你自己的Cloudflare账户。 在Oyster上,计算机是一个 Linux 工作空间在 a Cloudflare Contain, 墨卡普读取并撰写其 `/workspace`。 。 。 .

## 尽你所能

-   浏览 Computer 文件夹并打开标签中的文件 .
-   编辑带有语法加亮的文本,并保存为 **缩写+S** 编号 : **⌘S**。 。 。 .
-   预览图像(PNG,JPEG,GIF,WebP,SVG和AVIF)和视频(MP4和WebM).
-   打开 **预览下图** 用于任何 `.md` 文档.
-   创建文件和文件夹, **文件另存为** 其它路径, 或下载草稿 不写它.
-   解决冲突:当一个文件在打开后在计算机上更改时, 选择 **留着我的**, (中文(简体) ), **重新装入他们的** 或者说 **比较** 在事情发生之前 覆写.

关闭未保存编辑的标签或 App 询问是否保存、丢弃或 撤销。 在电话里, **打开文件探索器** 把探险家带过编辑器.

![Inkcap on a phone in the light theme, with no file open and a New draft button](https://npmcn.com/package/%40fungi.computer/inkcap/docs/media/new-draft-phone.png)

## 拿来

墨卡普与其他起动App安装. 在已部署的牡蛎上(参见: [牡蛎快开始](https://github.com/fungi-computer/oyster#deploy-to-cloudflare), (中文(简体) ), 运行 :

```sh
export OYSTER_URL=https://oyster.<your-subdomain>.workers.dev
export OYSTER_OWNER_KEY=<your owner key>
npx oyster install-apps
```

安装者复制此寄存器和另外六个, 种子在您的 牡蛎与 `git push`,在您的计算机上构建并安装它们。 签名 时间 `$OYSTER_URL/login` 带着主人的钥匙 打开Tourtois的墨卡普 桌面。 运行 `install-apps` 用于更新;每个 App 保留其数据.

## 换一下

每个已安装的 App 也是您可以在自己的牡蛎上叉出的一个模板. 叉头 墨子卡普输入 Bonsai 仓库, 用普通复制它 `git`数字 :

```sh
curl -X POST -H "Authorization: Bearer $OYSTER_OWNER_KEY" -H 'content-type: application/json' \
  -d '{"appId":"app_inkcap","name":"my-inkcap"}' \
  $OYSTER_URL/apps/bonsai/methods/apps.fork
git -c http.extraHeader="Authorization: Bearer $OYSTER_OWNER_KEY" \
  clone $OYSTER_URL/git/bonsai/my-inkcap.git
```

回复名称为您的叉子的 App id和寄存器 。 按下您的编辑, 打开 在 Bonsai 中保存并选择 **设置**,则 **构建安装( S)** 与那个 App ID 和您的承诺 `git:<sha>`。在 `inkcap` 改为 替换运行中的 Inkcap, 或在新的 ID 中保留两者.

要从 GitHub 取而代之, 叉出此寄存器并指示安装器 你的叉子用着 `--repositories <base URL>` 财务报告和审定财务报表 `--ref <branch or tag>`编辑 安装者读取所有7个起动器 Apps 从该底部,所以将它们分叉在一个下 账户.

## 代理工具

特工通过牡蛎的MCP端点调用"墨卡普",或者在 `POST $OYSTER_URL/apps/inkcap/methods/<name>` 有密钥; 见 [Git、 密钥和 MCP](https://github.com/fungi-computer/oyster#git-keys-and-mcp)。 。 。 .

| 方法 | 它会做什么 |
| --- | --- |
| `listFiles({path?, limit?, offset?})` | 读取目录一页,最多256个条目. |
| `readFile({path, byteOffset?, byteLength?})` | 最多读取一个文件的128个KiB作为base64. |
| `writeFile({path, content, expectedContent?})` | 写入 UTF-8 文本, 仅在文件仍然保存时可选择 `expectedContent`。 。 。 . |
| `documents.recent` | 列出最近打开和编辑的 Inkcap 文档. |

路径是绝对的,不能包含 `..`。只读附件无法写入, 而主机选择计算机:没有参数选择一个.

## 构建和检查

"墨子"(英語:Inkcap)是一款由Vite所建的回放App. 文件树和编辑器来自 `@pierre/trees` 财务报告和审定财务报表 `@pierre/diffs`,以及来自 [盖子](https://github.com/fungi-computer/caps)。 。 。 .

```sh
pnpm install
pnpm build
pnpm typecheck
pnpm test
```

[src/InkcapApp.tsx (英语)](https://npmcn.com/package/%40fungi.computer/inkcap/src/InkcapApp.tsx) 拥有标签、所选计算机和 关闭检查. [src/use 档案文件.ts](https://npmcn.com/package/%40fungi.computer/inkcap/src/useFileDocument.ts) 拥有每个 草案、其节省的基线和冲突恢复。 代理工具在 [后端/方法数](https://npmcn.com/package/%40fungi.computer/inkcap/backend/methods.ts),以及 [软件包.json](https://npmcn.com/package/%40fungi.computer/inkcap/package.json) 声明 App 要求的权限 .

## 许可证

麻省理工学院. 见 [自由主义](https://npmcn.com/package/%40fungi.computer/inkcap/LICENSE)。 。 。 .

## 常见问题

### @fungi\.computer/inkcap 是什么？

墨盒: 编辑您计算机上的文件, 牡蛎的 App

### 如何安装 @fungi\.computer/inkcap？

在项目目录运行 npm install @fungi\.computer/inkcap，或使用 pnpm add / yarn add / bun add。

### @fungi\.computer/inkcap 支持 TypeScript 吗？

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

### @fungi\.computer/inkcap 支持 ESM 还是 CommonJS？

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

### @fungi\.computer/inkcap 可以商用吗？

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

### @fungi\.computer/inkcap 的下载量有多少？

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

### @fungi\.computer/inkcap 还在维护吗？

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