From 67837917e5073416d37aac8425f65dd516e2716b Mon Sep 17 00:00:00 2001 From: SikongJueluo Date: Thu, 17 Sep 2026 17:52:55 +0800 Subject: [PATCH] docs(readme): point install instructions at npm packages - add npm package links to the package tables in both READMEs - list per-package npm installs before the whole-repo git install --- README.md | 19 ++++++++++++++----- README.zh-CN.md | 19 ++++++++++++++----- 2 files changed, 28 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 22425b0..221e074 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,27 @@ Personal extensions for the [pi](https://www.npmjs.com/package/@earendil-works/p ## Packages -| Package | Description | -|---|---| -| [pi-permission-ai-judge](packages/pi-permission-ai-judge) | AI judge — a model rules allow / deny / defer on each pending Bash ask; shadow logs only, enforce auto-approves | -| [pi-permission-inner-cmd](packages/pi-permission-inner-cmd) | Unwraps transparent Bash wrappers (`timeout`, `time`, …) and authorizes the inner command | +| Package | npm | Description | +|---|---|---| +| [pi-permission-ai-judge](packages/pi-permission-ai-judge) | [@sikongjueluo/pi-permission-ai-judge](https://www.npmjs.com/package/@sikongjueluo/pi-permission-ai-judge) | AI judge — a model rules allow / deny / defer on each pending Bash ask; shadow logs only, enforce auto-approves | +| [pi-permission-inner-cmd](packages/pi-permission-inner-cmd) | [@sikongjueluo/pi-permission-inner-cmd](https://www.npmjs.com/package/@sikongjueluo/pi-permission-inner-cmd) | Unwraps transparent Bash wrappers (`timeout`, `time`, …) and authorizes the inner command | ## Install +Per package from npm: + +```bash +pi install npm:@sikongjueluo/pi-permission-ai-judge +pi install npm:@sikongjueluo/pi-permission-inner-cmd +``` + +Or the whole repo via git (both extensions mount through the root `package.json` `pi.extensions` manifest): + ```bash pi install git:github.com/SikongJueluo/pi-extensions ``` -The package manifest (root `package.json`, `pi.extensions`) mounts both extensions declaratively — effective in any directory. Prerequisites: +Either way, effective in any directory. Prerequisites: 1. Enable [`@gotgenes/pi-permission-system`](https://github.com/gotgenes/pi-permission-system) ≥ 32 2. Add the extensions to the authorizer chain — order is consultation order, UI sessions only: diff --git a/README.zh-CN.md b/README.zh-CN.md index c15465b..944b517 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -6,18 +6,27 @@ ## 包 -| 包 | 说明 | -|---|---| -| [pi-permission-ai-judge](packages/pi-permission-ai-judge) | AI 判官。模型对每条待确认的 Bash 命令给出 allow / deny / defer;shadow 只记日志,enforce 代批放行 | -| [pi-permission-inner-cmd](packages/pi-permission-inner-cmd) | 解包透明包装命令(`timeout`、`time` 等),按内层命令授权 | +| 包 | npm | 说明 | +|---|---|---| +| [pi-permission-ai-judge](packages/pi-permission-ai-judge) | [@sikongjueluo/pi-permission-ai-judge](https://www.npmjs.com/package/@sikongjueluo/pi-permission-ai-judge) | AI 判官。模型对每条待确认的 Bash 命令给出 allow / deny / defer;shadow 只记日志,enforce 代批放行 | +| [pi-permission-inner-cmd](packages/pi-permission-inner-cmd) | [@sikongjueluo/pi-permission-inner-cmd](https://www.npmjs.com/package/@sikongjueluo/pi-permission-inner-cmd) | 解包透明包装命令(`timeout`、`time` 等),按内层命令授权 | ## 安装 +按包从 npm 安装: + +```bash +pi install npm:@sikongjueluo/pi-permission-ai-judge +pi install npm:@sikongjueluo/pi-permission-inner-cmd +``` + +或整仓 git 安装(两个扩展经根 `package.json` 的 `pi.extensions` 清单挂载): + ```bash pi install git:github.com/SikongJueluo/pi-extensions ``` -包清单(根 `package.json` 的 `pi.extensions`)声明式挂载两个扩展,任意目录生效。前提: +两种方式均任意目录生效。前提: 1. 启用 [`@gotgenes/pi-permission-system`](https://github.com/gotgenes/pi-permission-system) ≥ 32 2. 把扩展挂进授权链——顺序即咨询顺序,仅 UI 会话生效: