@usepipr/runtime 0.1.3 → 0.2.1

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/README.md ADDED
@@ -0,0 +1,42 @@
1
+ # @usepipr/runtime
2
+
3
+ `@usepipr/runtime` owns Pipr's config loading, Action and local command
4
+ execution, Diff Manifest creation, Pi execution, review validation, and
5
+ publication planning.
6
+
7
+ ## Technical Notes
8
+
9
+ - The package root exports command APIs for init, Action runs, dry runs,
10
+ config checks, plan inspection, and local review.
11
+ - `./runtime-tools-extension` is the static Pi runtime tools extension loaded
12
+ during condensed Diff Manifest runs.
13
+ - `./internal/testing` is an unsupported test surface for Pipr's private e2e
14
+ harness.
15
+ - The build emits ESM and declaration files to `dist`.
16
+
17
+ ## Source Map
18
+
19
+ | Path | Responsibility |
20
+ | --- | --- |
21
+ | `src/action` | CLI and GitHub Action command orchestration |
22
+ | `src/config` | `.pipr/config.ts` loading, init files, recipes, and SDK stubs |
23
+ | `src/diff` | Diff Manifest parsing, projection, ranges, and path filters |
24
+ | `src/pi` | Pi subprocess contract, runtime tools, and provider wiring |
25
+ | `src/review` | Task execution, agent prompts, validation, comments, and publication plans |
26
+ | `src/hosts` | Code host adapters for GitHub and local runs |
27
+
28
+ ## Commands
29
+
30
+ ```bash
31
+ bun run --cwd packages/runtime test:config-init
32
+ bun run --cwd packages/runtime test:config-loader
33
+ bun run --cwd packages/runtime test:core
34
+ bun run --cwd packages/runtime check
35
+ ```
36
+
37
+ ## Docs
38
+
39
+ - [Runtime Guide](https://pipr.run/docs/guide/runtime)
40
+ - [Comments and Findings](https://pipr.run/docs/guide/comments)
41
+ - [Architecture](https://pipr.run/docs/reference/architecture)
42
+ - [Trust and Security](https://pipr.run/docs/guide/trust-security)