breakaway 1.0.1-main.1 → 1.0.1-main.3
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 +13 -13
- package/package.json +1 -1
- package/prompts/install.md +2 -2
- package/scripts/tasks/init.js +4 -5
- package/src/cli-version.js +2 -2
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
<a href="#run-your-own"><b>Run your own</b></a> ·
|
|
15
15
|
<a href="#how-it-works">How it works</a> ·
|
|
16
16
|
<a href="#docs">Docs</a> ·
|
|
17
|
-
<a href="https://
|
|
17
|
+
<a href="https://leavethepack.dev">Website</a> ·
|
|
18
18
|
<a href="#licence">Licence</a>
|
|
19
19
|
</p>
|
|
20
20
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
Paste this into [Claude Code](https://claude.com/claude-code), in an empty folder:
|
|
30
30
|
|
|
31
31
|
```text
|
|
32
|
-
Set up a breakaway board for me. Read https://
|
|
32
|
+
Set up a breakaway board for me. Read https://leavethepack.dev/install.md and follow it.
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
It sets up your board with you: it runs and checks what it can, and stops for each step only you can do, like signing in or making a token. It never asks for a secret in the chat.
|
|
@@ -122,22 +122,22 @@ npx breakaway list --ready
|
|
|
122
122
|
<img alt="How breakaway is built. Three ways in: the web board, the CLI, and Taskwarrior. They reach one Worker and its Durable Object on your own Cloudflare account, which holds every task. The board talks to GitHub through its own GitHub App, and starts Claude Code cloud agents through your routine; agents work the board through the CLI." src="https://raw.githubusercontent.com/TheAnarchoX/breakaway/main/docs/media/built-dark.png" width="100%">
|
|
123
123
|
</picture>
|
|
124
124
|
|
|
125
|
-
One Cloudflare Worker serves the API, the web app (Preact), and Taskwarrior sync, and one SQLite Durable Object holds every task, claim, comment, and change. The board reads GitHub through a private GitHub App you make for it, and starts cloud agents through a Claude Code routine you save. [Architecture](https://
|
|
125
|
+
One Cloudflare Worker serves the API, the web app (Preact), and Taskwarrior sync, and one SQLite Durable Object holds every task, claim, comment, and change. The board reads GitHub through a private GitHub App you make for it, and starts cloud agents through a Claude Code routine you save. [Architecture](https://leavethepack.dev/docs/architecture/) has the rest.
|
|
126
126
|
|
|
127
127
|
## Docs
|
|
128
128
|
|
|
129
129
|
| Read | For |
|
|
130
130
|
| --- | --- |
|
|
131
|
-
| [Run your own board](https://
|
|
132
|
-
| [Concepts](https://
|
|
133
|
-
| [Playbook](https://
|
|
134
|
-
| [Agents](https://
|
|
135
|
-
| [Ideas, decisions, and pings](https://
|
|
136
|
-
| [The CLI](https://
|
|
137
|
-
| [GitHub](https://
|
|
138
|
-
| [Taskwarrior](https://
|
|
139
|
-
| [Deploying](https://
|
|
140
|
-
| [FAQ](https://
|
|
131
|
+
| [Run your own board](https://leavethepack.dev/docs/quickstart/) | From nothing to a board that starts agents and updates itself |
|
|
132
|
+
| [Concepts](https://leavethepack.dev/docs/concepts/) | Tasks and work IDs, areas, horizons, claims, dependencies, and how a pull request closes a task |
|
|
133
|
+
| [Playbook](https://leavethepack.dev/docs/playbook/) | Write tasks agents finish, run many agents without collisions, and keep the review load to one person |
|
|
134
|
+
| [Agents](https://leavethepack.dev/docs/agents/) | Cloud agents from the board, local agents, limits, live output, and messaging a running agent |
|
|
135
|
+
| [Ideas, decisions, and pings](https://leavethepack.dev/docs/ideas-decisions-pings/) | Let an agent shape an idea, answer its questions in a form, and get a ping when only you can help |
|
|
136
|
+
| [The CLI](https://leavethepack.dev/docs/cli/) | Every command of `npx breakaway` |
|
|
137
|
+
| [GitHub](https://leavethepack.dev/docs/github/) | Your own private App, how pull requests link to tasks, and merging, promoting, and rolling back |
|
|
138
|
+
| [Taskwarrior](https://leavethepack.dev/docs/taskwarrior/) | Sync, reports, and contexts with Taskwarrior 3 |
|
|
139
|
+
| [Deploying](https://leavethepack.dev/docs/deploying/) | Releases, channels, the Deploy and Update workflows, and rollbacks |
|
|
140
|
+
| [FAQ](https://leavethepack.dev/docs/faq/) | The licence, your data, what it works with, and what it won't do |
|
|
141
141
|
|
|
142
142
|
<details>
|
|
143
143
|
<summary><b>Run it locally</b></summary>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "breakaway",
|
|
3
|
-
"version": "1.0.1-main.
|
|
3
|
+
"version": "1.0.1-main.3",
|
|
4
4
|
"description": "The task board for you and your coding agents: a Cloudflare Worker, its web app, Taskwarrior sync, and the CLI (npx breakaway).",
|
|
5
5
|
"license": "FSL-1.1-Apache-2.0",
|
|
6
6
|
"type": "module",
|
package/prompts/install.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
You're helping someone set up their own breakaway board: a task board for them and their coding agents, on their own Cloudflare account. It's theirs: they own it, run it, and decide. You do the typing. This file is the whole job. Read it to the end before you start, then work through it one step at a time.
|
|
4
4
|
|
|
5
|
-
The owner started you with something like: "Set up a breakaway board for me. Read https://
|
|
5
|
+
The owner started you with something like: "Set up a breakaway board for me. Read https://leavethepack.dev/install.md and follow it." The full guide behind these steps is at https://leavethepack.dev/docs/quickstart/, if a step needs more detail.
|
|
6
6
|
|
|
7
7
|
## How you work
|
|
8
8
|
|
|
@@ -125,4 +125,4 @@ Only with a Claude plan that has routines. Otherwise skip to step 7.
|
|
|
125
125
|
|
|
126
126
|
Run `npx breakaway connections` and go through anything that still needs attention, with the fix each row gives. Taskwarrior is optional: if they use it, `npx breakaway setup` connects it.
|
|
127
127
|
|
|
128
|
-
Then add a first task together, in a checkout of the repository: `npx breakaway add "<something small that needs doing>" --project <area> --tag agent --horizon now`. Show them the board. Tell them where things are: the board in their browser, `npx breakaway help` for the CLI, and the docs at https://
|
|
128
|
+
Then add a first task together, in a checkout of the repository: `npx breakaway add "<something small that needs doing>" --project <area> --tag agent --horizon now`. Show them the board. Tell them where things are: the board in their browser, `npx breakaway help` for the CLI, and the docs at https://leavethepack.dev/docs/. Then stop. From here on, the board is theirs.
|
package/scripts/tasks/init.js
CHANGED
|
@@ -24,12 +24,11 @@ export const CLI_PACKAGE = 'breakaway@next';
|
|
|
24
24
|
*/
|
|
25
25
|
export const CLI_ENTRIES = ['scripts/tasks.mjs', 'scripts/tasks/session-hook.mjs', 'scripts/tasks/message-wait.mjs'];
|
|
26
26
|
/**
|
|
27
|
-
* While breakaway
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* public, set this to false: the hooks run through npx again, and `repos init --update` removes the copy.
|
|
27
|
+
* While breakaway was private, nothing reached npm (BRK-57), so repos init copied the two hooks and what they import
|
|
28
|
+
* under HOOKS_DIR and settings.json ran them from there (BRK-64). breakaway is public and on npm now, so the hooks run
|
|
29
|
+
* through npx again (BRK-69), and `repos init --update` removes a copy an older repos init left.
|
|
31
30
|
*/
|
|
32
|
-
export const HOOKS_FROM_COPY =
|
|
31
|
+
export const HOOKS_FROM_COPY = false;
|
|
33
32
|
/** The session hooks' entry files, and where their copy goes: its own folder, so it never touches the repository's src/. */
|
|
34
33
|
export const HOOK_ENTRIES = ['scripts/tasks/session-hook.mjs', 'scripts/tasks/message-wait.mjs'];
|
|
35
34
|
export const HOOKS_DIR = 'tools/tasks/cli/';
|
package/src/cli-version.js
CHANGED
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
* bump CLI_VERSION and set CLI_FINGERPRINT to the value it prints. Constants only: the board's Worker imports it,
|
|
6
6
|
* so it lives in the board's package (CLD-135) and the CLI imports it from here.
|
|
7
7
|
*/
|
|
8
|
-
export const CLI_VERSION =
|
|
9
|
-
export const CLI_FINGERPRINT = '
|
|
8
|
+
export const CLI_VERSION = 36;
|
|
9
|
+
export const CLI_FINGERPRINT = '252bee7de1e280f7';
|