breakaway 1.0.0 → 1.0.1-main.2

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 +14 -14
  2. package/package.json +1 -1
  3. package/prompts/install.md +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://breakaway.samewave.dev">Website</a> ·
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://breakaway.samewave.dev/install.md and follow it.
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://breakaway.samewave.dev/docs/architecture/) has the rest.
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://breakaway.samewave.dev/docs/quickstart/) | From nothing to a board that starts agents and updates itself |
132
- | [Concepts](https://breakaway.samewave.dev/docs/concepts/) | Tasks and work IDs, areas, horizons, claims, dependencies, and how a pull request closes a task |
133
- | [Playbook](https://breakaway.samewave.dev/docs/playbook/) | Write tasks agents finish, run many agents without collisions, and keep the review load to one person |
134
- | [Agents](https://breakaway.samewave.dev/docs/agents/) | Cloud agents from the board, local agents, limits, live output, and messaging a running agent |
135
- | [Ideas, decisions, and pings](https://breakaway.samewave.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://breakaway.samewave.dev/docs/cli/) | Every command of `npx breakaway` |
137
- | [GitHub](https://breakaway.samewave.dev/docs/github/) | Your own private App, how pull requests link to tasks, and merging, promoting, and rolling back |
138
- | [Taskwarrior](https://breakaway.samewave.dev/docs/taskwarrior/) | Sync, reports, and contexts with Taskwarrior 3 |
139
- | [Deploying](https://breakaway.samewave.dev/docs/deploying/) | Releases, channels, the Deploy and Update workflows, and rollbacks |
140
- | [FAQ](https://breakaway.samewave.dev/docs/faq/) | The licence, your data, what it works with, and what it won't do |
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>
@@ -169,7 +169,7 @@ pnpm interop # checks sync against real Taskwarrior 3
169
169
  <details>
170
170
  <summary><b>Releases</b></summary>
171
171
 
172
- breakaway publishes releases and never deploys. Every install, the owner's included, deploys a release from its own repository, and this repository holds no Cloudflare credentials.
172
+ breakaway publishes releases and never deploys an install. Every install, the owner's included, deploys a release from its own repository, and this repository holds no Cloudflare credentials. Its website follows the latest stable release: the release moves the `site` branch, and Cloudflare deploys it ([`site/README.md`](https://github.com/TheAnarchoX/breakaway/blob/main/site/README.md#deploy-it)).
173
173
 
174
174
  - **Every merge to `main`**, once CI passes, publishes a GitHub pre-release `vX.Y.Z-main.N` on the `main` channel. It carries the bundle (`breakaway-bundle.tar.gz`: the Worker's files and the web app's `dist`), a `manifest.json` (version, channel, commit, `manual`, and the lowest version it updates from), and `SHA256SUMS`. The notes list the merged pull requests by title.
175
175
  - **A stable release** `vX.Y.Z` is the owner's: they run the **Release** workflow with the pre-release to promote. The bundle is that pre-release's, unchanged, and the notes cover everything since the last stable.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "breakaway",
3
- "version": "1.0.0",
3
+ "version": "1.0.1-main.2",
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://breakaway.samewave.dev/install.md and follow it." The full guide behind these steps is at https://breakaway.samewave.dev/docs/quickstart/, if a step needs more detail.
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://breakaway.samewave.dev/docs/. Then stop. From here on, the board is theirs.
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.