# @delorenj/pjangler 中文文档

规范地址：https://npmcn.com/package/%40delorenj/pjangler/

版本：1\.5\.47
npm 元数据更新时间：2026-11-10T22:54:22.596Z
中文译文更新时间：2026-11-11T21:55:27.800Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：2.8 MB，69 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=24
- 运行依赖：10 个
- 首次发布：2026-06-01T19:15:31.159Z
- 最新版本发布：2026-11-10T22:54:22.274Z
- 近 30 天下载量：5870（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：73（近 12 个月 73 个）

## 中文简介

项目子系统靴子CLI

## 安装

```sh
npm install @delorenj/pjangler
```

也可以使用：`pnpm add @delorenj/pjangler`、`yarn add @delorenj/pjangler`、`bun add @delorenj/pjangler`

## README

# 长相机

项目定义现存于存储库 `.project.json` 一个不区分大小写的文件 `project_id`启用 `pj info`, (中文(简体) ), `pj list`,以及 `pj doctor`; 单通 PostgreSQL 登记索引 。 见 [项目登记册](https://npmcn.com/package/%40delorenj/pjangler/docs/project-registry.md) 用于安装、迁移和相容性细节.

项目子系统靴子CLI+MCP服务器.

## 安装

需要节点24或更新。 项目技能的使用 `@delorenj/skillex` 0.1.2;见 [融入合同](https://npmcn.com/package/%40delorenj/pjangler/docs/skillex-integration.md)。 。 。 .

```bash
git submodule update --init --recursive   # templates/commonproject; a plain clone leaves it empty
npm install
npm run build
```

`npm test` (文字/运行测试.mjs)需要该子模块: `check:submodule-checkout` 闸门在输入命令时失败 `templates/commonproject` 为空。 这个 后置套房读取标准 `PG*` 变量; 将其指向 可支配服务器( CI 使用 `postgres:16` 服务). `PJANGLER_REQUIRE_DISPOSABLE_POSTGRES=1` 使丢失的邮箱/ psql/ bun 失败, 而不是像 CI 那样跳过 .

## CLI 使用情况

```bash
npm run build
node dist/index.js --help
# or if installed globally
pjangler --help
```

## 仓库忽略合同

普通项目保留现有 `.gitignore` 只添加可移植 机密和当地项目规则 `.agents` 预测。 从来没有复制过 运算符 `core.excludesFile`。 。 。 . `.agents/` 是唯一的犬类代理 - 配置 树; `.claude/`, (中文(简体) ), `.codex/`,并生成其他支持客户端根 整个机器覆盖的地方预测忽略了政策. `bmad.cli-roots` 仅删除先前由 pjangler 生成的准确的已过时行, 绝不 更改 Git 的索引。 使用 `gitignore-maintenance` 提高审计效率的技能 规则出处和调和已跟踪的被忽略路径.

## 项目笔记本

`pjangler notebook` 管理已注册的 open Notebook 附录 仓库。 具有约束性和稳定性的概览说明 `.project.json` 和项目登记册;终点、认证模式、默认和有限度 捕获限制在登记册的全球 `notebook` 配置 .

```bash
pjangler notebook status . --json
pjangler notebook create . --live --json
pjangler notebook list notes . --json
pjangler notebook search notes "release evidence" . --json
pjangler notebook audit . --json
pjangler notebook migrate . --live --apply --json
```

对 `SessionStart` 财务报告和审定财务报表 `SessionEnd` 钩子是分开投影的 工程瞄准钩主. 他们的每笔存款政策一直不开放,而且 在明确启用之前已禁用 `.project.json`。 。 。 .

## 均等审计

BMAD 配方支持可选的拥有者提供的 g33 配方用于注册 33个GOD项目,有明确的选择入/出、不写预览和结构化 选择性结果。 见 [g33 伴侣](https://npmcn.com/package/%40delorenj/pjangler/docs/g33-companion.md) 可调用者 配置和实际 `pj recipe run bmad --dry-run --json` 命令.

`pjangler audit` 对寄存器执行确定性33个神的对等规则 并当其中任何一个失败时退出. `pjangler migrate` 应用 一能修自有道所宣说.

```bash
pjangler audit                                          # every rule, human report
pjangler audit --json                                   # machine-parseable
pjangler audit --rules mise.config-root,sot.project-json
pjangler migrate sot.project-json --dry-run
pjangler migrate --all
```

`--rules` 只报告您命名的规则。 一个未知的ID是 **错误,永远不要 空传** ——一个召客探究一条规则,得知规则已去 而不是无所事事地读一份干净的报告.

`pjangler audit --json` 编辑 `pjangler_list_parity_rules` MCP 工具报告 活目录. 规则属于配方 `src/recipes/`,而不是通过一个 中心表,所以目录是唯一存在目录的权威.

## 斜边插件

`pjangler init <name> --obsidian-plugin` 做一切正常的事务 (登记, `.project.json`,板子,BMAD,技能,钩子,迷信,内行. 不同之处在于通用项目渲染:它是建立在 犬类 [丁二醇-样本-丙丁](https://github.com/obsidianmd/obsidian-sample-plugin)。 。 。 . 这意味着 `manifest.json`, (中文(简体) ), `versions.json`, npm + 正在构建 + 类型脚本 `src/`, (中文(简体) ), `eslint-plugin-obsidianmd`,并构建/发布自备跑者的工作流程.

```bash
pjangler init tag-wrangler --obsidian-plugin --description "Wrangle tags across a vault"
cd tag-wrangler && npm install && npm run dev
mise run plugin:link ~/Vaults/Main   # symlink into <vault>/.obsidian/plugins/<id>
```

-   该类型记录为 `template.commonproject.project_type` 内 `.copier-answers.yml`。它固定在创建时,并重新运行 `init` 留着吧.
-   在已存在的 repo 上, 旗帜只记录类型, 并且只在 repo 时 已经有女神了 `manifest.json`。 。 。 .
-   `mise run version:bump` 保留 `package.json`, (中文(简体) ), `manifest.json` 财务报告和审定财务报表 `versions.json` 步入正轨。 从来没有标记。 释放方式 `npm version patch|minor|major`,哪个 执行,然后标记为空 `X.Y.Z` (Obsidian 匹配),并推标签.
-   MCP的选择与 `projectType: "obsidian-plugin"` 打开 `pjangler_project_init` 财务报告和审定财务报表 `pjangler_bootstrap_33god_project`。 。 。 .

## 探员

pjangler不雇用、提供或检查代理人。 那是弗卢姆的地表.. `flume hire`, (中文(简体) ), `flume roster`, (中文(简体) ), `flume record`, (中文(简体) ), `flume review` ——和兽形图 是弗卢姆的记录.

`pjangler describe` 仍然报告一个仓库的雇员,和 `pjangler init` 载有 `.project.json` `agents` 条目向前。 既不写新 一,该块是 org 图表的单向投影,而不是一个项目的地点 声明意图.

## 定位在回转中

`describe` 读取回波并报告其实际情况——检测类型, 已安装的子系统、 已显示的配置文件以及下一步要做什么 。 这是 第一次叫特工(或人类)到不熟悉的地方降落,很有效 在任何回购,33GOD与否.

```bash
pjangler describe                # current directory
pjangler describe ../some-repo
pjangler describe --json         # machine-parseable, for agent context
pjangler describe --interactive  # tick off fixable findings, press A to apply
```

子系统存在和子系统正确性分别报告:存在 来源于磁盘上的标记文件,对等来自食谱本身的审计规则. A 类 从未安装的子系统读取 `absent`没有 `broken`。 。 。 .

### 最后活动,不是生命周期状态

项目报告 **上次工作的时候**而不是一个生命周期词。 旧的 `status` 字段表示 `planned` 27个已登记项目中的22个——包括 他们同日犯罪,故他从不造化,也不知情.

活动从读取时的基特计算,所以它不能 store and no cron 必须走注册。 它的长度超过退出分支 :

| 来源 | 覆盖 |
| --- | --- |
| 参考 | 每个本地分支、 远程跟踪分支和标签 |
| 工作树 | 每一个相关的工作树的头, 包括那些不忠者 |
| 未承付 | 尚未执行的工作树编辑 |

其中最出名的获胜者,获胜者总是被报道. 远程 状态反映了您最后的获取—— 这里没有触及到网络 .

`pj list` 由这个信号命令, 最新的工作首先.

## 贝壳提示

`pjangler-prompt` 当工作目录在 a 内时打印一行紧凑 pjangler项目,没有,如果不是:

```
pjangler (PJAN) · 3m
```

它与主要CLI是独立的二进制——CLI装入整个 等同规则设定并需要~52 ms才能启动, 而这个运行在~30 ms, 里面很长 星舰的500米预算.

添加到 `~/.config/starship.toml` 作为第二个工程范围快线:

```toml
format = "…$all${custom.pjangler}$line_break$character"

[custom.pjangler]
description = "pjangler project context"
when = true
shell = ["sh"]
symbol = "◆"
style = "bold purple"
# The newline lives INSIDE the conditional group, so nothing is emitted —
# not even a blank line — outside a pjangler project.
format = "(\n[$symbol $output]($style))"
command = 'exec pjangler-prompt 2>/dev/null'
```

`$line_break` 必须明确命名:它被下列因素吸收: `$all` 财务报告和审定财务报表 额外线路降落在错误的地方.

## MCP 服务器使用情况

跑过Stdio:

```bash
npm run mcp
# or
pjangler-mcp
```

已曝光的工具 :

-   `pjangler_list_capabilities`
-   `pjangler_list_parity_rules`
-   `pjangler_audit_project`
-   `pjangler_migrate_project`
-   `pjangler_bootstrap_33god_project`
-   `pjangler_project_init`
-   `pjangler_project_list`
-   `pjangler_project_show`
-   `pjangler_info`
-   `pjangler_describe_project`
-   `pjangler_describe_recipe`
-   `pjangler_run_recipe`

## 常见问题

### @delorenj/pjangler 是什么？

项目子系统靴子CLI

### 如何安装 @delorenj/pjangler？

在项目目录运行 npm install @delorenj/pjangler，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 pj、pjangler、pjangler-mcp、pjangler-prompt，可以用 npx pj 直接运行。

### @delorenj/pjangler 支持 TypeScript 吗？

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

### @delorenj/pjangler 支持 ESM 还是 CommonJS？

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

### @delorenj/pjangler 需要什么版本的 Node\.js？

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

### @delorenj/pjangler 可以商用吗？

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

### @delorenj/pjangler 的下载量有多少？

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

### @delorenj/pjangler 还在维护吗？

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