Kanbus

Ways to run

Preview

Files in the cloud

Push the board to a hosted git repository and everyone with a clone works from it, from laptops, agent sandboxes and CI, with optional live updates and a hosted board.

How it works

The board is the same project/ folder as in local files, pushed to GitHub, GitLab or any git host. A person on a laptop, an agent in a cloud coding sandbox and a CI job each have a clone and use the same kbs commands. Git moves changes between clones when someone pushes.

Two optional layers sit on top. A shared MQTT broker announces every change the moment it happens, so other clones show it before they pull. A hosted board on AWS serves the pushed board in a browser, behind a login, for people who never clone the repository.

Set it up

  1. Set up a local board first. Follow local files, and give the board a project key that is unique to this repository. Live updates are routed by project key, so two repositories that share one see each other's changes.

  2. Push it to a hosted repository.

    git remote add origin git@github.com:acme/website.git
    git push -u origin main
    
  3. Join from another clone, whether that is a teammate's laptop, an agent sandbox or a CI job. Each clone only needs a Kanbus CLI.

    git clone git@github.com:acme/website.git
    cd website
    kbs setup env KANBUS_USER --value bob@example.com
    kbs list
    
  4. Work in a pull, change, commit, push loop. Each issue is its own file, so new issues from different clones never conflict. Agents should run kbs commit and push at the end of every task.

    git pull
    kbs update acme-aeec87 --status in_progress
    kbs commit
    git push
    
  5. Optional: add live updates. Point every clone at the same MQTT broker in .kanbus.yml. Your files stay the source of truth; the broker only carries notifications.

    realtime:
      transport: mqtt
      broker: mqtt://broker.example.com:1883
      autostart: false
    
  6. Optional: add a hosted board. Deploy the AWS stack in infra/cloud, add a GitHub push webhook for the repository, and give each person the Cognito attributes for that board.

Read the full guideRead the hosted board runbook

Good to know

  • If two clones change the same issue between pushes, git pull reports a conflict in that issue's file. Keep the pushed version, then repeat your own change with kbs, and run kbs validate to confirm every file parses.
  • For work several agents might pick up at once, use kbs coordination so only one of them claims an issue.
  • One sign-in maps to one hosted board today.