bitfolk 0.1.5 → 0.1.7

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.
Files changed (3) hide show
  1. package/README.md +22 -1
  2. package/dist/cli.js +120 -68
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -47,7 +47,7 @@ release rather than reuse one it cached. Installed, it also answers to the short
47
47
  | `bitfolk approvals` | What agents wait on you for; `bitfolk approve <id>` and `bitfolk deny <id>` answer one |
48
48
  | `bitfolk tools` | The coding tools found here, on or off |
49
49
  | `bitfolk add <tool>` / `rm <tool>` | Turn a tool on or off, or add your own with `--command` or `--acp` |
50
- | `bitfolk set --repo <path>` | Give sessions a git repo; `--max-usd`, `--max-runs`, `--timeout`, `--permission` change limits |
50
+ | `bitfolk set --repo <path>` | Give sessions a git repo; `--pull-requests on` opens pull requests that merge once you approve; `--max-usd`, `--max-runs`, `--timeout`, `--permission` change limits |
51
51
  | `bitfolk share <port>` | Share an app running here at a link |
52
52
  | `bitfolk check` | Check sign-in, tools and repo (also `bitfolk doctor`) |
53
53
  | `bitfolk bug "<what>"` | Report a bug |
@@ -212,6 +212,27 @@ On a Mac, `bitfolk up` keeps the computer awake while it runs (`caffeinate -i`,
212
212
  the runner does). The screen can still sleep. Closing the lid on battery still sleeps the Mac and pauses sessions.
213
213
  `bitfolk up --let-sleep` turns this off.
214
214
 
215
+ ## Pull requests
216
+
217
+ With a GitHub repo, builders' work can go up for review and merge into your main branch once you approve it:
218
+
219
+ ```
220
+ bitfolk set --repo ~/code/app --pull-requests on
221
+ ```
222
+
223
+ 1. Connect GitHub in Bitfolk under Tools → Connected apps.
224
+ 2. When a session succeeds with commits, the runner pushes its `bitfolk/builder-<id>` branch to the repo's GitHub
225
+ `origin`, with your own git credentials (no prompts, no hooks). Only a GitHub origin is pushed to.
226
+ 3. Bitfolk opens a pull request into the branch from `--base` (or origin's default branch, else `main`) through your
227
+ GitHub connection, and asks you to approve "Merge pull request #N into main" on your phone, the web, Slack or with
228
+ `bitfolk approve <id>`.
229
+ 4. Once a person approves it, Bitfolk merges the pull request within a minute, at the exact commit you were shown. A
230
+ rule, an approval habit, the Coordinator or an agent's say-so never merges one. If a fix pushes new commits, the
231
+ earlier approval is retired and you're asked again.
232
+
233
+ `bitfolk logs <id>` shows the pull request and whether it merged. `--pull-requests off` keeps branches on this
234
+ computer again.
235
+
215
236
  ## Long-lived agents
216
237
 
217
238
  `bitfolk add bfa_...` still adds a permanent agent with a token copied from its page on your workspace, and `bitfolk up`