Skip to content

armgit / kanzo

Public Imported from GitHub
0

Self-hosted, sharable kanban for humans and agents. One 4.7 MB binary, 5 MB of RAM, 10 to 60 tokens per agent reply, starts in 3 ms, zero setup.

Explain sharing in the README, and make it simpler

emanuele-emfb057130e366
diff --git a/README.md b/README.md
index 3b3677e..6ad4171 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,13 @@
<a href="LICENSE"><img src="https://img.shields.io/badge/license-AGPL--3.0-blue" alt="AGPL-3.0"></a>
</p>
-Kanzo is a kanban board in your browser and an MCP server in one small program, so you and your coding agents work on the same tasks. The whole board is one folder, and a private git repo keeps it in step on every machine you use: no account, no server.
+Kanzo is a kanban board in your browser and an MCP server in one 4.5 MB program, so you and your coding agents work on the same tasks. No account, no server, no setup: run `kanzo` and the board is open.
+
+You never edit a file. Everything is done in one of three places:
+
+- **the board**, in your browser, for you;
+- **MCP**, for your agents: they take tasks, move cards and comment;
+- **the `kanzo` command**, for the terminal and scripts.
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/img/board-dark.gif">
@@ -38,28 +44,15 @@ Every release is signed by GitHub: check a download with `gh attestation verify
cargo install kanzo
```
-## Use
+## Start
-| Command | Does |
-| --- | --- |
-| `kanzo` | Starts the board at http://localhost:4242 and opens it; `--port` for another port, `--no-open` to not open it |
-| `kanzo service install` | Keeps the board running and starts it at login; `uninstall` removes it |
-| `kanzo mcp` | The MCP server for agents: they start it, not you |
-| `kanzo sync` | Commits the board and pulls or pushes it; `--repo <url>` sets the repo, `--keep-local` or `--keep-remote` when both sides changed |
-| `kanzo export` | Prints the board as Markdown; `-f json` for JSON, `-p <project>` for one project, `-o <file>` to save it |
-| `kanzo update` | Installs the latest release and restarts the board's service; the board offers new versions too |
-| `kanzo init` | Creates the data folder; the first run does this too |
-| `kanzo --version` | Prints the version |
-
-Every command takes `--home <dir>` to use another data folder.
-
-`n` adds a task, `/` or `⌘K` searches every project, `Tab` moves to the description, `⌘↵` saves and closes, `Esc` cancels.
-
-Need somewhere to park ideas? Turn on the Backlog column in Settings, at the bottom of the sidebar: agents leave its tasks alone until you move them to `todo`.
+```sh
+kanzo
+```
-Paste or drop an image into a task or a comment to attach it, as in ChatGPT. Agents get its file path and can open it.
+The board opens at http://localhost:4242. That's all the setup there is: the first run creates `~/kanzo`, and the whole board lives in it.
-When a new version is out, the sidebar offers it: one click installs it and restarts the board.
+`n` adds a task, `/` or `⌘K` searches every project, `Tab` moves to the description, `⌘↵` saves and closes, `Esc` cancels. Mark a task Human and agents leave it to you; the person icon shows only those. Paste or drop an image into a task or a comment to attach it. When a new version is out, the sidebar offers it: one click installs it.
## Connect your agents
@@ -77,9 +70,54 @@ Then ask: *"take the next task from kanzo and do it."* The agent moves the card
<img alt="A task open on the board, with Claude Code's comments and a reply" src="docs/img/task-light.jpg">
</picture>
-## Your board on every machine
+## Share it on your network
+
+Several computers, one board, at the same time: everyone sees the same tasks, and every agent works on them.
+
+<table>
+ <tr>
+ <td><picture>
+ <source media="(prefers-color-scheme: dark)" srcset="docs/img/share-dark.jpg">
+ <img alt="The share popover on the computer with the board: sharing is on, with its address to copy and the computers connected" src="docs/img/share-light.jpg">
+ </picture></td>
+ <td><picture>
+ <source media="(prefers-color-scheme: dark)" srcset="docs/img/join-dark.jpg">
+ <img alt="The share popover on another computer: connected to the shared board, with a Leave button" src="docs/img/join-light.jpg">
+ </picture></td>
+ </tr>
+ <tr>
+ <td>On the computer with the board</td>
+ <td>On every other computer</td>
+ </tr>
+</table>
-A laptop, a desktop, a Raspberry Pi: they all share one board through a private git repo you own.
+1. On the computer with the board, click the share icon next to New task and turn on **Share this board**. Copy the address it shows.
+2. On each other computer, click the share icon, paste the address and click **Join**.
+
+Nothing restarts and nothing needs configuring. Their board shows the shared one, and their agents use it through the same `kanzo mcp`, still finding the project from the repo they work in. Turn sharing off, or click **Leave**, at any time.
+
+From a terminal, or for an agent, it's `kanzo share on` and `kanzo join <address>`, then `kanzo share off` and `kanzo leave`. There are no logins: share only on a network you trust.
+
+## Commands
+
+| Command | Does |
+| --- | --- |
+| `kanzo` | Starts the board at http://localhost:4242 and opens it; `--port` for another port, `--no-open` to not open it |
+| `kanzo service install` | Keeps the board running and starts it at login; `uninstall` removes it |
+| `kanzo mcp` | The MCP server for agents: they start it, not you |
+| `kanzo share on` | Shares the board with the other computers on your network; `off` stops, while the board keeps running |
+| `kanzo join <ip>` | Uses the board another computer shares, from this one's board and agents; `kanzo leave` goes back |
+| `kanzo sync` | Commits the board and pulls or pushes it; `--repo <url>` sets the repo, `--keep-local` or `--keep-remote` when both sides changed |
+| `kanzo export` | Prints the board as Markdown; `-f json` for JSON, `-p <project>` for one project, `-o <file>` to save it |
+| `kanzo update` | Installs the latest release and restarts the board's service; the board offers new versions too |
+| `kanzo init` | Creates the data folder; the first run does this too |
+| `kanzo --version` | Prints the version |
+
+Every command takes `--home <dir>` to use another data folder. Need somewhere to park ideas? Turn on the Backlog column in Settings: agents leave its tasks alone until you move them to `todo`.
+
+## Sync between machines
+
+To carry the board between machines you work on one at a time, a private git repo you own keeps it in step.
1. [Create an empty private repo](https://github.com/new?name=kanzo-data&visibility=private) on GitHub, or anywhere git can push.
2. Click Settings at the bottom of the sidebar, choose Sync and paste its URL. Kanzo makes `~/kanzo` a git repo and pushes the board.
@@ -87,15 +125,13 @@ A laptop, a desktop, a Raspberry Pi: they all share one board through a private
From then on, choose Sync, or run `kanzo sync`, when you switch machines. It commits the board and pulls or pushes it, and it's safe while the board and your agents are running. If both machines changed the board, Kanzo asks which one to keep. To move to another repo, change it in Settings, under Sync.
-Sync is for switching machines: work on one, sync, then move to the other. For agents on several machines at once, run one board with `listen = "0.0.0.0"` on a network you trust, and point every agent at `http://<host>:4242/mcp`, passing the project by name.
-
## Settings
-Everything lives in `~/kanzo`: the board in `kanzo.db`, settings in `config.toml`. Use another folder with `--home` or `KANZO_HOME`.
+Everything lives in `~/kanzo`: the board in `kanzo.db`, settings in `config.toml`. You never need to open either; use another folder with `--home` or `KANZO_HOME`.
```toml
port = 4242
-listen = "127.0.0.1" # "0.0.0.0" opens the board to your network: no logins, so only on one you trust
+listen = "127.0.0.1" # sharing opens the board to your network; "0.0.0.0" keeps it open
mcp_http = true # MCP at /mcp
```
@@ -103,7 +139,7 @@ mcp_http = true # MCP at /mcp
| | |
| --- | --- |
-| Program | 4.1 MB, SQLite included |
+| Program | 4.5 MB, SQLite included |
| Memory | 4.5 MB idle, 8 MB with 3,000 tasks |
| Start | 2 ms |
| Board of 3,000 tasks | 17 ms to load in the browser |
diff --git a/docs/img/join-dark.jpg b/docs/img/join-dark.jpg
new file mode 100644
index 0000000..63ba5be
Binary files /dev/null and b/docs/img/join-dark.jpg differ
diff --git a/docs/img/join-light.jpg b/docs/img/join-light.jpg
new file mode 100644
index 0000000..7c6cbf5
Binary files /dev/null and b/docs/img/join-light.jpg differ
diff --git a/docs/img/share-dark.jpg b/docs/img/share-dark.jpg
new file mode 100644
index 0000000..7ad34a4
Binary files /dev/null and b/docs/img/share-dark.jpg differ
diff --git a/docs/img/share-light.jpg b/docs/img/share-light.jpg
new file mode 100644
index 0000000..5f9ac5c
Binary files /dev/null and b/docs/img/share-light.jpg differ