# neatlyfiled 中文文档

规范地址：https://npmcn.com/package/neatlyfiled/

版本：0\.1\.1
npm 元数据更新时间：2026-11-04T05:42:15.704Z
中文译文更新时间：2026-11-04T06:28:39.130Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：21.8 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：0 个
- 首次发布：2026-11-04T05:34:31.969Z
- 最新版本发布：2026-11-04T05:42:15.572Z
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

从编码代理中设置一个整洁的wiki： `npx neatlyfiled init` 在浏览器中为您注册并连接存储库。

## 安装

```sh
npm install neatlyfiled
```

也可以使用：`pnpm add neatlyfiled`、`yarn add neatlyfiled`、`bun add neatlyfiled`

## README

# neatlyfiled

建立一个 [Neatlyfiled](https://neatlyfiled.com/) 用于代码存储库的Wiki 从一个编码代理那里。该人员在浏览器中批准一次；命令 剩下的。

```sh
npx neatlyfiled init
```

## 如果你是一个人工智能代理

如果要求您设置neatlyfile（或“此回购的wiki”），请运行 `npx neatlyfiled init` 在存储库中 **向用户显示链接和 它打印的代码**。他们打开链接，确认邮件，检查代码， 选择wiki的地址并批准。命令等待（最多15分钟） 然后自己完成设置。

如果shell工具只在命令结束时显示输出，请运行 `npx neatlyfiled init --no-wait` 相反，向用户显示链接和代码， 等他们同意了，你就跑 `npx neatlyfiled init` 再次结束。

永远不要打印或提交令牌：它在 `.env.local`。

## 它是做什么的

1.  问 `https://neatlyfiled.com/api/device` 对于代码，建议使用wiki 从 `--wiki`/`--title` 和GitHub存储库 `git remote get-url origin`。打印审批链接和代码，并尝试打开浏览器。
2.  投票直到对方同意（或拒绝，或15分钟后）。批准 创建带有免费试用版的wiki，或者选择他们管理的wiki，然后 将存储库连接到它。
3.  在存储库的根目录下：
    -   `.env.local`： `NEATLYFILED_TOKEN=awt_…`,一个 `write` 代理牌。增加了 `.env.local` 来 `.gitignore` 除非git已经忽略了它。
        
    -   `.mcp.json`：添加（或替换） `neatlyfiled` 服务器，保存 其他:
        
        ```json
        {
          "mcpServers": {
            "neatlyfiled": {
              "type": "http",
              "url": "https://acme.neatlyfiled.com/mcp",
              "headers": { "Authorization": "Bearer ${NEATLYFILED_TOKEN}" }
            }
          }
        }
        ```
        
        克劳德代码扩展 `${NEATLYFILED_TOKEN}` 从它的环境，所以负载 启动前的文件： `set -a; . ./.env.local; set +a`。其他 客户端：可流的HTTP `url` 用那个头。
        
    -   `.github/workflows/neatlyfiled-wiki.yml`：运行 [`neatlyfiled/wiki-from-diff`](https://github.com/neatlyfiled/wiki-from-diff#readme) 操作，每次推送到默认分支，由GitHub的 OIDC令牌（无秘密）：它在wiki中记录推送并给出 为您自己的代理步骤执行一个短暂的wiki令牌。提交和 按它启动。
        

## 选项

| 选项 |  |
| --- | --- |
| `--wiki <id>` | 建议的Wiki地址(`acme` → `acme.neatlyfiled.com`）. |
| `--title <name>` | 维基名称建议。 |
| `--no-mcp` | 不要写 `.mcp.json`。 |
| `--no-workflow` | 不要添加工作流。 |
| `--yes` | 替换现有的不同工作流文件。 |
| `--no-browser` | 不要尝试打开审批页面。 |
| `--no-wait` | 打印链接和代码并退出；运行 `init` 再次结束。 |
| `--client <name>` | 谁在询问，在审批页面上显示并命名令牌(默认：检测到，例如； `claude-code`）. |

`NEATLYFILED_URL` 将命令指向另一个服务器（默认值） `https://neatlyfiled.com`）. 要求Node 22或更高版本；没有依赖关系。

## 没有节点

HTTP上的相同流描述在 [https://neatlyfiled.com/llms.txt](https://neatlyfiled.com/llms.txt)。

## 常见问题

### neatlyfiled 是什么？

从编码代理中设置一个整洁的wiki： npx neatlyfiled init 在浏览器中为您注册并连接存储库。

### 如何安装 neatlyfiled？

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

### neatlyfiled 支持 TypeScript 吗？

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

### neatlyfiled 支持 ESM 还是 CommonJS？

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

### neatlyfiled 需要什么版本的 Node\.js？

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

### neatlyfiled 可以商用吗？

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

### neatlyfiled 还在维护吗？

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