feat(coding-agent): isolate SproutClaw namespace from upstream pi
Some checks failed
CI / build-check-test (push) Has been cancelled
Some checks failed
CI / build-check-test (push) Has been cancelled
Use piConfig name sproutclaw and configDir .sproutclaw so commands, env vars, and project config no longer collide with the stock pi install. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
20
README.md
20
README.md
@@ -24,7 +24,7 @@
|
||||
| `scripts/sync-upstream.sh` | 合并上游 pi-mono 更新 |
|
||||
| `scripts/push-sproutclaw.sh` | 推送到 GitHub / Gitea |
|
||||
|
||||
> `.pi/agent/` 为本地持久化配置目录(settings、auth、sessions、extensions、skills 等),已整体加入 `.gitignore`,不进入版本控制。
|
||||
> `.sproutclaw/agent/` 为本地持久化配置目录(settings、auth、sessions、extensions、skills 等),已整体加入 `.gitignore`,不进入版本控制。与原版 pi 的 `~/.pi/agent/` 完全隔离。
|
||||
|
||||
## 常用命令
|
||||
|
||||
@@ -159,6 +159,7 @@ npm run build
|
||||
|
||||
合并上游时,以下内容**不要误删**:
|
||||
|
||||
- `packages/coding-agent/package.json` 中 `piConfig.name = sproutclaw`、`configDir = .sproutclaw`(命名空间隔离)
|
||||
- `showChangelogOnStartup` 设置项(关闭启动 What's New)
|
||||
- RPC 扩展:`reload` 命令、bash 流式输出(`bash_update`)、`get_extensions` 接口
|
||||
- `sproutclaw` / `build.sh` / `test.sh` 等启动脚本
|
||||
@@ -167,19 +168,32 @@ npm run build
|
||||
|
||||
## 本地配置
|
||||
|
||||
`.pi/agent/` 中以下内容不进 Git:
|
||||
`.sproutclaw/agent/` 中以下内容不进 Git:
|
||||
|
||||
- `settings.json` → 参考 `settings.example.json` 本地复制
|
||||
- `models.json`、`auth.json`、`mcp.json`
|
||||
- `sessions/`、`skills/`、`extensions/`、`prompts/`
|
||||
|
||||
环境变量(可选):
|
||||
|
||||
- `SPROUTCLAW_CODING_AGENT_DIR` — 覆盖 agent 配置目录,默认 `<repo>/.sproutclaw/agent`
|
||||
|
||||
首次部署:
|
||||
|
||||
```bash
|
||||
cp .pi/agent/settings.example.json .pi/agent/settings.json
|
||||
cp .sproutclaw/agent/settings.example.json .sproutclaw/agent/settings.json
|
||||
# 编辑 settings.json 填入 provider / model / auth 信息
|
||||
```
|
||||
|
||||
### 与原版 pi 并存
|
||||
|
||||
| | 原版 pi | SproutClaw |
|
||||
|---|---|---|
|
||||
| 命令 | `pi` | `sproutclaw` / `mengya` |
|
||||
| 全局配置 | `~/.pi/agent/` | `~/.sproutclaw/agent/` |
|
||||
| 项目配置 | `.pi/` | `.sproutclaw/` |
|
||||
| 环境变量 | `PI_CODING_AGENT_DIR` | `SPROUTCLAW_CODING_AGENT_DIR` |
|
||||
|
||||
## 说明
|
||||
|
||||
这个仓库是自用 fork,默认围绕树萌芽的服务器环境、部署规范和日常开发习惯调整。上游能力来自 pi-mono,通过 `git fetch upstream && git merge upstream/main` 定期同步,sproutclaw 定制在 `feature/*` 开发后合入 `main`。
|
||||
|
||||
Reference in New Issue
Block a user