pi-bro 0.22.0 → 0.22.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +44 -0
- package/README.md +116 -987
- package/bro.ts +2 -2
- package/docs/README.md +6 -2
- package/docs/pig-compatibility.md +1 -1
- package/docs/user-guide.md +986 -0
- package/package.json +13 -7
- package/prompt.ts +1 -1
- package/sources.ts +68 -11
package/bro.ts
CHANGED
|
@@ -1567,7 +1567,7 @@ export function helpText(settings?: BroSettings, settingsError?: string, prefere
|
|
|
1567
1567
|
: `Bro could not read its settings: ${settingsError}\n\nRun \`/bro doctor\` for setup help.`;
|
|
1568
1568
|
return `# Bro
|
|
1569
1569
|
|
|
1570
|
-
Quick reference.
|
|
1570
|
+
Quick reference. Full user guide: https://github.com/tranhoangnguyen03/pi-bro/blob/main/docs/user-guide.md
|
|
1571
1571
|
|
|
1572
1572
|
## Explain and show
|
|
1573
1573
|
|
|
@@ -1633,7 +1633,7 @@ The mode decides how much of the source to keep; your preferences decide who it'
|
|
|
1633
1633
|
|
|
1634
1634
|
## Privacy
|
|
1635
1635
|
|
|
1636
|
-
Bro sends the captured source (or, for the advisor, the executor's instructions, tools, and conversation) to the selected backend and its model provider, which may retain it under their own policies. Your preferences go with every explain, show, btw, and Guided Review request. Guided Review sends PR data/diff and relevant private questions; records/source remain locally under getAgentDir()/bro-reviews. Copy finding goes to the system clipboard, not GitHub. Nothing is added to Pi's conversation unless you insert it. Access controls differ by backend; see the
|
|
1636
|
+
Bro sends the captured source (or, for the advisor, the executor's instructions, tools, and conversation) to the selected backend and its model provider, which may retain it under their own policies. Your preferences go with every explain, show, btw, and Guided Review request. Guided Review sends PR data/diff and relevant private questions; records/source remain locally under getAgentDir()/bro-reviews. Copy finding goes to the system clipboard, not GitHub. Nothing is added to Pi's conversation unless you insert it, except advisor answers, which return to the agent as tool results. Access controls differ by backend; see the user guide.`;
|
|
1637
1637
|
}
|
|
1638
1638
|
|
|
1639
1639
|
// The overlay framing pattern is adapted from pi-btw (MIT); see THIRD_PARTY_NOTICES.md.
|
package/docs/README.md
CHANGED
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
# pi-bro docs
|
|
2
2
|
|
|
3
|
-
- [README](../README.md) — the
|
|
3
|
+
- [README](../README.md) — the short overview: install, try it, requirements, data flow.
|
|
4
|
+
- [user-guide.md](user-guide.md) — the full user guide (authoritative for behavior).
|
|
4
5
|
- [guided-review.md](guided-review.md) — current Guided Review behavior, optional controls, access/storage and limits.
|
|
6
|
+
- [pig-compatibility.md](pig-compatibility.md) — experimental PiG support and its limits.
|
|
5
7
|
- [DEVELOPMENT.md](DEVELOPMENT.md) — code map, settings and BTW continuation model, invariants, test commands.
|
|
6
8
|
- [TESTING.md](TESTING.md) — the manual end-to-end checklist across backends.
|
|
9
|
+
- [test-consolidation.md](test-consolidation.md) — the #74 test coverage ledger.
|
|
10
|
+
- [PUBLIC-PRESENTATION.md](PUBLIC-PRESENTATION.md) — how pi-* repos present themselves publicly; sister repos follow it too.
|
|
7
11
|
- [dev/README.md](../dev/README.md) — manual review launcher and profile/call precautions (not shipped).
|
|
8
12
|
- [plans/](plans/README.md) — historical design notes and plans; not the current spec.
|
|
9
|
-
- [images/](images/) — screenshots used by the README.
|
|
13
|
+
- [images/](images/) — screenshots used by the README and user guide.
|
|
10
14
|
- [benchmark/README.md](../benchmark/README.md) — the manual, live prompt benchmark.
|
|
@@ -31,7 +31,7 @@ Bro follows the host's `getAgentDir()`: normally `~/.pi/agent` on Pi and `~/.pig
|
|
|
31
31
|
|
|
32
32
|
```sh
|
|
33
33
|
npm test
|
|
34
|
-
PIG_BIN=/absolute/path/to/pig sh pig-test.sh
|
|
34
|
+
PIG_BIN=/absolute/path/to/pig sh test/pig-test.sh
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
The PiG lane checks the exact binary version, real host settings isolation, advisor snapshot compaction/branch projection, and the existing fake-backend RPC smoke suite. Existing Node tests cover backend cancellation/process cleanup and modal geometry, but are not substitutes for real-host interactive tests.
|