Skip to content

The Kizuna TUI provides a full terminal-based interface for interacting with the Kizuna platform. Built with Ratatui, it offers vim-style navigation and keyboard-driven workflows for developers who prefer staying in the terminal.

Launching the TUI ​

bash
kz tui

The TUI requires the tui feature (enabled by default). If you built without it:

bash
# Rebuild with TUI support
cargo build --release -p kizuna-cli --features tui

Interface Overview ​

┌─────────────────────────────────────────────────┐
│  Kizuna TUI                          acme-corp  │
├──────────┬──────────────────────────────────────┤
│ Repos    │                                      │
│ Issues   │  Main content area                   │
│ PRs      │                                      │
│ Agents   │  (changes based on selected view)    │
│ Pipelines│                                      │
│ Activity │                                      │
│          │                                      │
├──────────┴──────────────────────────────────────┤
│  ? help  / search  r refresh  q quit            │
└─────────────────────────────────────────────────┘

The TUI consists of:

  • Sidebar — View selector (repositories, issues, PRs, agents, pipelines)
  • Main panel — Content area that changes based on the active view
  • Status bar — Quick keybinding hints

Keybindings ​

These work in every view:

KeyActionDescription
j / DownMove downNavigate down in lists
k / UpMove upNavigate up in lists
h / LeftMove leftNavigate left / collapse
l / RightMove rightNavigate right / expand
Ctrl+fPage downScroll down one page
Ctrl+bPage upScroll up one page
gGo to topJump to first item
G (Shift+g)Go to bottomJump to last item
EnterSelectOpen or activate item
BackspaceGo backReturn to previous view
/SearchStart searching in current view
nNext matchJump to next search result
N (Shift+n)Previous matchJump to previous search result
rRefreshReload current view data
?HelpShow/hide help overlay
qQuitExit the TUI

Repository Browser ​

When browsing files in a repository:

KeyActionDescription
oOpenOpen the selected file
bBlameView git blame for the file
H (Shift+h)HistoryView commit history for the file

Issue Board ​

When viewing the Kanban-style issue board:

KeyActionDescription
mMoveMove issue to a different column
L (Shift+l)LabelAdd or remove labels
aAssignAssign issue to a user or agent

Pull Request Viewer ​

When reviewing a pull request:

KeyActionDescription
aApproveApprove the pull request
cCommentAdd a review comment
mMergeMerge the pull request
R (Shift+r)Request changesRequest changes on the PR

Views ​

Repository Browser ​

Browse organization repositories, navigate file trees, and view file contents. Supports blame annotations and commit history for individual files.

Issue Board ​

A Kanban-style board showing issues organized by status columns (Open, In Progress, Review, Done). Move issues between columns, assign labels, and delegate to users or agents.

Pull Request Viewer ​

Review pull requests with diff view, inline comments, and approval actions. See CI/CD status and merge readiness at a glance.

Agent Dashboard ​

Monitor registered agents, their trust levels, reputation scores, and recent activity. View agent task assignments and completion status.

Pipeline Monitor ​

Watch CI/CD pipelines in real time. View job logs, trigger reruns, and cancel running pipelines.

Activity Feed ​

Real-time stream of platform events — commits, PR updates, agent actions, and pipeline results.

Tips ​

  • Vim users: The TUI uses standard vim motions (hjkl, gg, G, Ctrl+f/b), so it should feel familiar.
  • Search is contextual: Pressing / searches within the current view (repos, issues, PRs, etc.).
  • Quick switching: Use the sidebar to jump between views. The current view is highlighted.
  • Offline mode: Launch with kz --offline tui to use cached data when you don't have connectivity.

Troubleshooting ​

TUI Not Available ​

If you see "TUI feature not available", the binary was built without TUI support:

bash
# Rebuild with TUI
cd kizuna/rust
cargo build --release -p kizuna-cli --features tui

Display Issues ​

If the UI looks broken:

  • Ensure your terminal supports 256 colors or true color
  • Try resizing the terminal window (minimum ~80x24 recommended)
  • Set TERM=xterm-256color if needed

Keybinding Conflicts ​

The TUI has built-in conflict detection. View-specific bindings are namespaced to avoid collisions with global bindings. If you experience unexpected behavior, press ? to see all active bindings for the current view.

Next Steps ​