prloom 0.1.0
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/LICENSE +21 -0
- package/README.md +114 -0
- package/dist/cli/index.js +23426 -0
- package/manual_agent.md +164 -0
- package/package.json +38 -0
- package/prompts/designer.md +36 -0
- package/prompts/review_triage.md +63 -0
- package/prompts/worker.md +33 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Sergey Melnikov
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# prloom
|
|
2
|
+
|
|
3
|
+
`prloom` is a terminal-first “agentic PR factory” for developers.
|
|
4
|
+
|
|
5
|
+
You write a plan (a Markdown checklist), `prloom` turns it into a dedicated git worktree + branch, opens a draft PR, and then iterates one TODO at a time using a configurable coding agent. Review happens in GitHub: comments and review submissions are triaged into new TODOs and pushed back onto the same PR.
|
|
6
|
+
|
|
7
|
+
`prloom` is designed to be safe to run from multiple clones: all runtime state lives in `.prloom/` (gitignored), so each developer can run their own dispatcher against the PRs they create/track in their local state.
|
|
8
|
+
|
|
9
|
+
## How It Works
|
|
10
|
+
|
|
11
|
+
- Plans start locally in `.prloom/inbox/` (gitignored; clean `git status`).
|
|
12
|
+
- The dispatcher ingests a plan into a new branch/worktree at `plans/<id>.md` and opens a draft PR.
|
|
13
|
+
- The worker agent executes exactly one TODO per iteration and updates the plan in-branch.
|
|
14
|
+
- PR comments/reviews trigger a triage agent which updates the plan with new TODOs and posts a reply.
|
|
15
|
+
- When all TODOs are complete, the PR is marked ready; you merge when satisfied.
|
|
16
|
+
|
|
17
|
+
## Requirements
|
|
18
|
+
|
|
19
|
+
- Node.js (for running via `npx`)
|
|
20
|
+
- Git
|
|
21
|
+
- GitHub CLI (`gh`) authenticated for the repo
|
|
22
|
+
- At least one supported agent CLI installed:
|
|
23
|
+
- `opencode`
|
|
24
|
+
- `codex`
|
|
25
|
+
- `claude`
|
|
26
|
+
|
|
27
|
+
## Install
|
|
28
|
+
|
|
29
|
+
For end-users, prefer `npx` (see Usage).
|
|
30
|
+
|
|
31
|
+
For local development:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
bun install
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Usage
|
|
38
|
+
|
|
39
|
+
### NPX (recommended)
|
|
40
|
+
|
|
41
|
+
In your target repository:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npx -y prloom init
|
|
45
|
+
npx -y prloom new my-feature
|
|
46
|
+
npx -y prloom start
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Local dev
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
bun run dev <command>
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Or build the standalone CLI:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
bun run build
|
|
59
|
+
# then run: ./dist/cli/index.js <command>
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Commands
|
|
63
|
+
|
|
64
|
+
- `prloom init`
|
|
65
|
+
- Initializes `.prloom/`, ensures `.prloom/` is gitignored, and writes `prloom.config.json`.
|
|
66
|
+
- `prloom new [plan-id] [--agent <codex|opencode|claude>]`
|
|
67
|
+
- Creates `.prloom/inbox/<id>.md` and launches an interactive designer session.
|
|
68
|
+
- `prloom start`
|
|
69
|
+
- Starts the dispatcher loop (ingests inbox plans, runs TODOs, polls PR feedback).
|
|
70
|
+
- `prloom status`
|
|
71
|
+
- Shows inbox plans and active plans tracked in `.prloom/state.json`.
|
|
72
|
+
- `prloom edit <plan-id> [--agent <...>]`
|
|
73
|
+
- Edits a plan either in inbox (pre-dispatch) or in the plan’s worktree (post-dispatch).
|
|
74
|
+
- `prloom stop <plan-id>` / `prloom unpause <plan-id>`
|
|
75
|
+
- Pauses/resumes automation for an active plan.
|
|
76
|
+
- `prloom open <plan-id>`
|
|
77
|
+
- Opens the configured agent’s interactive TUI in the plan worktree (requires paused).
|
|
78
|
+
- `prloom poll [plan-id]`
|
|
79
|
+
- Forces an immediate PR-feedback poll.
|
|
80
|
+
- With `<plan-id>`: poll once for that plan without shifting its schedule.
|
|
81
|
+
- Without `<plan-id>`: poll now and reset the schedule for all active plans.
|
|
82
|
+
|
|
83
|
+
## Basic Workflow
|
|
84
|
+
|
|
85
|
+
1. Initialize prloom:
|
|
86
|
+
- `npx -y prloom init`
|
|
87
|
+
2. Create a plan:
|
|
88
|
+
- `npx -y prloom new my-feature`
|
|
89
|
+
3. Start the dispatcher:
|
|
90
|
+
- `npx -y prloom start`
|
|
91
|
+
3. Review the draft PR in GitHub.
|
|
92
|
+
4. Leave PR comments or a review; `prloom` triages feedback into TODOs.
|
|
93
|
+
5. When the PR is ready, merge it.
|
|
94
|
+
|
|
95
|
+
## Configuration
|
|
96
|
+
|
|
97
|
+
Create `prloom.config.json` in the repo root:
|
|
98
|
+
|
|
99
|
+
```json
|
|
100
|
+
{
|
|
101
|
+
"agents": {
|
|
102
|
+
"default": "opencode",
|
|
103
|
+
"designer": "codex"
|
|
104
|
+
},
|
|
105
|
+
"worktrees_dir": ".prloom/worktrees",
|
|
106
|
+
"poll_interval_ms": 60000,
|
|
107
|
+
"base_branch": "main"
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Notes
|
|
112
|
+
|
|
113
|
+
- Runtime state is stored under `.prloom/` (gitignored).
|
|
114
|
+
- The plan file is committed on the PR branch at `plans/<id>.md` and lands on the configured `base_branch` only when you merge the PR.
|