bitfolk 0.1.7 → 0.1.9

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 +38 -0
  2. package/dist/cli.js +70 -68
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -46,6 +46,8 @@ release rather than reuse one it cached. Installed, it also answers to the short
46
46
  | `bitfolk agents` | The workspace's agents: tool, builder or not, health, what each is doing |
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
+ | `bitfolk repos` | The git repos builders may work in; `repos add <path> [--name <n>]`, `repos rm <name>`, `repos default <name>` |
50
+ | `bitfolk set --primary <tool>` | The tool sessions use while it has usage left (`none` clears it) |
49
51
  | `bitfolk add <tool>` / `rm <tool>` | Turn a tool on or off, or add your own with `--command` or `--acp` |
50
52
  | `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
53
  | `bitfolk share <port>` | Share an app running here at a link |
@@ -55,6 +57,12 @@ release rather than reuse one it cached. Installed, it also answers to the short
55
57
  `bitfolk help <command>` shows a command's options. Older forms keep working: `tool add`, `tool rm`, `ls`, `doctor`,
56
58
  `set machine`, and `run` with no words (or just an agent's name), which is `up`.
57
59
 
60
+ While `bitfolk up` runs on a terminal, a prompt under its status panel takes commands: type `status`, `sessions`,
61
+ `run "<what>"` (queued for this runner), `logs <id>`, `cancel <id>`, `approvals`, `approve <id>`, `chat`, `repos` and
62
+ the like, without `bitfolk` in front. Each runs as `bitfolk <command>` and its output scrolls above the panel. `help`
63
+ lists them, `quit` or Ctrl-C stops `up`. Commands that take over the terminal (`login`) or never end (`--follow`) stay
64
+ for another tab.
65
+
58
66
  On a terminal, waits show a twinkling loader with the time so far, and `bitfolk up` keeps one live line under its log
59
67
  (listening, builders working, cost so far). In a pipe, a log file, CI, or with `NO_COLOR`, `--no-color`, `TERM=dumb` or
60
68
  `BITFOLK_NO_ANIMATION=1`, it prints plain lines only.
@@ -212,6 +220,36 @@ On a Mac, `bitfolk up` keeps the computer awake while it runs (`caffeinate -i`,
212
220
  the runner does). The screen can still sleep. Closing the lid on battery still sleeps the Mac and pauses sessions.
213
221
  `bitfolk up --let-sleep` turns this off.
214
222
 
223
+ ## Repos and the primary tool
224
+
225
+ A computer can offer builders several git repos, each with a short name. Your workspace, its agents and the Run picker
226
+ see the names and GitHub repos, never the paths:
227
+
228
+ ```
229
+ bitfolk repos add ~/code/web # named web; the first repo is the default
230
+ bitfolk repos add ~/code/api
231
+ bitfolk repos add ~/code/site --name marketing
232
+ bitfolk repos default api
233
+ bitfolk run --in web "fix the signup form"
234
+ ```
235
+
236
+ A session works in the default repo unless it names another: `bitfolk run --in <name>`, the Run picker, an agent's
237
+ `use_computer` request (`params.repo`), or a message asking for builders that names the repo. Only git repos: every
238
+ session gets its own worktree and branch, so your checkouts stay as they are.
239
+
240
+ Sessions go to the coding tool with usage left. `bitfolk set --primary codex` makes Codex the one to use while it has
241
+ room; when it is out of usage or over 80% of its window, sessions go to the tool with the most left. The runner tells
242
+ your workspace each tool's usage when `bitfolk up` starts, every 10 minutes and after each session:
243
+
244
+ - Codex: the percent of each window used and when it resets, from its own session logs (`~/.codex/sessions`).
245
+ - Claude Code: what its last run said: a warning near the limit, or "limit reached" with the reset time. It reports
246
+ nothing while it has room, so it counts as having room until then.
247
+
248
+ A tool named on purpose always wins: `bitfolk run --runtime claude-code`, a tool picked on the Run picker, an agent's
249
+ `params.tool`, or a message asking for builders that names the tool ("builders, use Codex on api"). Builders and agents
250
+ see each tool's usage left and the repos (`GET /v1/computers`, and a "This computer" section in a builder's packet), so
251
+ they can pass on what someone in the chat asked for.
252
+
215
253
  ## Pull requests
216
254
 
217
255
  With a GitHub repo, builders' work can go up for review and merge into your main branch once you approve it: