butai documentation#
Start with Getting started to install butai, open a project, run an agent, and review your changes.
This manual describes butai 1.3.0, the current stable release.
Using butai#
| Guide | What you can do |
|---|---|
| Getting started | Install butai and work through your first session. |
| Windows | Use WSL2 and check native Windows limitations. |
| Workbench | Navigate projects, agents, files, and changes. |
| Keyboard shortcuts | Find shortcuts and change keybindings. |
| Command line | Look up commands, flags, and scripting examples. |
| Configuration | Configure agents, processes, and preferences. |
| Git | Review diffs, stage changes, commit, and manage branches. |
| Processes | Run and monitor servers, tests, and other commands. |
| Agent automation | Read panes and control butai from scripts or agents. |
| Remote access | Connect to projects on another machine over SSH. |
| Themes | Change colors or create a theme. |
| Troubleshooting | Fix common problems and collect a bug report. |
Building on butai#
For applications that connect to or embed the butai daemon:
| Reference | What it covers |
|---|---|
| Build a client | Connect to the daemon and build a client with the API. |
| Protocol | Message formats, terminal frames, and HTTP endpoints. |
| Embedding | Run butai inside another product, including security and deployment. |