<!DOCTYPE HTML>
<html lang="en" class="navy sidebar-visible" dir="ltr">
<head>
<meta charset="UTF-8">
<title>TUI - towl Documentation</title>
<meta name="description" content="Documentation for towl - a fast CLI tool to scan codebases for TODO comments">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">
<link rel="icon" href="../favicon.svg">
<link rel="shortcut icon" href="../favicon.png">
<link rel="stylesheet" href="../css/variables.css">
<link rel="stylesheet" href="../css/general.css">
<link rel="stylesheet" href="../css/chrome.css">
<link rel="stylesheet" href="../css/print.css" media="print">
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="../fonts/fonts.css">
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
<script>
const path_to_root = "../";
const default_light_theme = "navy";
const default_dark_theme = "navy";
window.path_to_searchindex_js = "../searchindex.js";
</script>
<script src="../toc.js"></script>
</head>
<body>
<div id="mdbook-help-container">
<div id="mdbook-help-popup">
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
<div>
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
<p>Press <kbd>?</kbd> to show this help</p>
<p>Press <kbd>Esc</kbd> to hide this help</p>
</div>
</div>
</div>
<div id="body-container">
<script>
try {
let theme = localStorage.getItem('mdbook-theme');
let sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<script>
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
let theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
const html = document.documentElement;
html.classList.remove('navy')
html.classList.add(theme);
html.classList.add("js");
</script>
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
<script>
let sidebar = null;
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
sidebar_toggle.checked = false;
}
if (sidebar === 'visible') {
sidebar_toggle.checked = true;
} else {
html.classList.remove('sidebar-visible');
}
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript>
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
</noscript>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">towl Documentation</h1>
<div class="right-buttons">
<a href="../print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/glottologist/towl" title="Git repository" aria-label="Git repository">
<i id="git-repository-button" class="fa fa-github"></i>
</a>
<a href="https://github.com/glottologist/towl/edit/main/docs/src/src/api/tui.md" title="Suggest an edit" aria-label="Suggest an edit" rel="edit">
<i id="git-edit-button" class="fa fa-edit"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<div class="search-wrapper">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
<div class="spinner-wrapper">
<i class="fa fa-spinner fa-spin"></i>
</div>
</div>
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<h1 id="tui"><a class="header" href="#tui">TUI</a></h1>
<p>The TUI module provides an interactive terminal interface for browsing, filtering, and acting on TODO comments. Built on <a href="https://ratatui.rs">ratatui</a> and <a href="https://github.com/crossterm-rs/crossterm">crossterm</a>.</p>
<h2 id="run"><a class="header" href="#run"><code>run</code></a></h2>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub fn run(
todos: Vec<TodoComment>,
github_config: &GitHubConfig,
repo_root: &Path,
) -> Result<(), TowlTuiError>
<span class="boring">}</span></code></pre></pre>
<p>Launches the interactive TUI. Takes ownership of the terminal (raw mode, alternate screen). Terminal state is always restored on exit, even on error.</p>
<p><strong>Errors:</strong></p>
<ul>
<li><code>TowlTuiError::Io</code> -- Terminal I/O failure</li>
</ul>
<h2 id="app"><a class="header" href="#app"><code>App</code></a></h2>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub struct App {
// private fields
}
<span class="boring">}</span></code></pre></pre>
<p>Core TUI application state. Manages the TODO list, selection set, cursor position, filtering, sorting, and mode transitions.</p>
<h3 id="constructor"><a class="header" href="#constructor">Constructor</a></h3>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub fn new(todos: Vec<TodoComment>) -> Self
<span class="boring">}</span></code></pre></pre>
<p>Creates a new app with all TODOs visible, no selection, sorted by file path.</p>
<h3 id="state-accessors"><a class="header" href="#state-accessors">State Accessors</a></h3>
<div class="table-wrapper"><table><thead><tr><th>Method</th><th>Returns</th><th>Description</th></tr></thead><tbody>
<tr><td><code>todos()</code></td><td><code>&[TodoComment]</code></td><td>Full TODO list</td></tr>
<tr><td><code>filtered_indices()</code></td><td><code>&[usize]</code></td><td>Indices into <code>todos()</code> after filtering/sorting</td></tr>
<tr><td><code>cursor()</code></td><td><code>usize</code></td><td>Current cursor position in filtered list</td></tr>
<tr><td><code>filter_type()</code></td><td><code>Option<TodoType></code></td><td>Active type filter (<code>None</code> = show all)</td></tr>
<tr><td><code>sort_field()</code></td><td><code>SortField</code></td><td>Current sort field</td></tr>
<tr><td><code>sort_ascending()</code></td><td><code>bool</code></td><td>Sort direction</td></tr>
<tr><td><code>is_selected(idx)</code></td><td><code>bool</code></td><td>Whether a TODO index is selected</td></tr>
<tr><td><code>selected_count()</code></td><td><code>usize</code></td><td>Number of selected TODOs</td></tr>
<tr><td><code>selected_todos()</code></td><td><code>Vec<TodoComment></code></td><td>Cloned copies of selected TODOs</td></tr>
<tr><td><code>mode()</code></td><td><code>&AppMode</code></td><td>Current UI mode</td></tr>
</tbody></table>
</div>
<h3 id="navigation"><a class="header" href="#navigation">Navigation</a></h3>
<div class="table-wrapper"><table><thead><tr><th>Method</th><th>Effect</th></tr></thead><tbody>
<tr><td><code>move_up()</code></td><td>Move cursor up (clamped to 0)</td></tr>
<tr><td><code>move_down()</code></td><td>Move cursor down (clamped to list end)</td></tr>
</tbody></table>
</div>
<h3 id="selection"><a class="header" href="#selection">Selection</a></h3>
<div class="table-wrapper"><table><thead><tr><th>Method</th><th>Effect</th></tr></thead><tbody>
<tr><td><code>toggle_select()</code></td><td>Toggle selection on cursor item</td></tr>
<tr><td><code>select_all_visible()</code></td><td>Select all items in filtered view</td></tr>
<tr><td><code>deselect_all()</code></td><td>Clear all selections</td></tr>
</tbody></table>
</div>
<h3 id="filtering-and-sorting"><a class="header" href="#filtering-and-sorting">Filtering and Sorting</a></h3>
<div class="table-wrapper"><table><thead><tr><th>Method</th><th>Effect</th></tr></thead><tbody>
<tr><td><code>cycle_filter()</code></td><td>Cycle: All -> TODO -> FIXME -> HACK -> NOTE -> BUG -> All</td></tr>
<tr><td><code>cycle_sort()</code></td><td>Cycle: File -> Line -> Priority -> Type -> File</td></tr>
<tr><td><code>reverse_sort()</code></td><td>Toggle ascending/descending</td></tr>
</tbody></table>
</div>
<h3 id="mode-transitions"><a class="header" href="#mode-transitions">Mode Transitions</a></h3>
<div class="table-wrapper"><table><thead><tr><th>Method</th><th>Transition</th></tr></thead><tbody>
<tr><td><code>enter_confirm()</code></td><td>Browse -> Confirm (requires selection)</td></tr>
<tr><td><code>cancel_confirm()</code></td><td>Confirm -> Browse</td></tr>
<tr><td><code>start_creating()</code></td><td>Confirm -> Creating</td></tr>
<tr><td><code>finish_creating()</code></td><td>Creating -> Done</td></tr>
<tr><td><code>enter_peek()</code></td><td>Browse -> Peek (loads source context)</td></tr>
<tr><td><code>exit_peek()</code></td><td>Peek -> Browse</td></tr>
</tbody></table>
</div>
<h2 id="appmode"><a class="header" href="#appmode"><code>AppMode</code></a></h2>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub enum AppMode {
Browse,
Peek(PeekState),
Confirm,
Creating(CreatingState),
Done(DoneState),
DeleteConfirm(Vec<TodoComment>),
}
<span class="boring">}</span></code></pre></pre>
<p>The current UI mode determines which view is rendered and which keys are active.</p>
<div class="table-wrapper"><table><thead><tr><th>Mode</th><th>View</th><th>Input</th></tr></thead><tbody>
<tr><td><code>Browse</code></td><td>Scrollable TODO list</td><td>Navigate, select, filter, sort, peek</td></tr>
<tr><td><code>Peek</code></td><td>Source code overlay around a TODO</td><td>Scroll, dismiss</td></tr>
<tr><td><code>Confirm</code></td><td>Summary of selected TODOs</td><td>Confirm or cancel</td></tr>
<tr><td><code>Creating</code></td><td>Progress indicator during issue creation</td><td>None (Ctrl+C to abort)</td></tr>
<tr><td><code>Done</code></td><td>Results summary (issues created, errors)</td><td>Dismiss to exit</td></tr>
<tr><td><code>DeleteConfirm</code></td><td>Confirmation dialog for deleting invalid TODOs</td><td>Confirm or cancel</td></tr>
</tbody></table>
</div>
<h2 id="sortfield"><a class="header" href="#sortfield"><code>SortField</code></a></h2>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub enum SortField {
File,
Line,
Priority,
Type,
}
<span class="boring">}</span></code></pre></pre>
<p>Field used to sort the TODO list. Cycle with the <code>s</code> key in Browse mode.</p>
<ul>
<li><strong>File</strong> -- Sort by file path, then by line number within each file</li>
<li><strong>Line</strong> -- Sort by line number globally</li>
<li><strong>Priority</strong> -- Sort by TODO type priority (Bug=1, Fixme=2, Hack=3, Todo=4, Note=5)</li>
<li><strong>Type</strong> -- Sort alphabetically by type name</li>
</ul>
<h2 id="supporting-types"><a class="header" href="#supporting-types">Supporting Types</a></h2>
<h3 id="peekstate"><a class="header" href="#peekstate"><code>PeekState</code></a></h3>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub struct PeekState {
pub lines: Vec<(usize, String)>,
pub file: String,
pub todo_line: usize,
pub scroll: usize,
pub analysis: Option<AnalysisResult>,
}
<span class="boring">}</span></code></pre></pre>
<p>State for the source-code peek overlay. Contains numbered source lines around the TODO, with scroll position. When <code>--ai</code> is active, <code>analysis</code> holds the LLM result -- the reasoning text is word-wrapped to the popup width during rendering.</p>
<h3 id="creatingstate"><a class="header" href="#creatingstate"><code>CreatingState</code></a></h3>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub struct CreatingState {
pub phase: String,
pub progress: usize,
pub total: usize,
pub errors: Vec<String>,
pub created_issues: Vec<CreatedIssue>,
}
<span class="boring">}</span></code></pre></pre>
<p>State tracked during background GitHub issue creation. Updated via channel messages from the spawned task.</p>
<h3 id="donestate"><a class="header" href="#donestate"><code>DoneState</code></a></h3>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub struct DoneState {
pub created_issues: Vec<CreatedIssue>,
pub errors: Vec<String>,
}
<span class="boring">}</span></code></pre></pre>
<p>Final state after issue creation completes, showing results and any errors.</p>
<h2 id="action"><a class="header" href="#action"><code>Action</code></a></h2>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub enum Action {
Continue,
Quit,
}
<span class="boring">}</span></code></pre></pre>
<p>Result of processing a keyboard event. <code>Continue</code> keeps the event loop running; <code>Quit</code> exits the TUI.</p>
<h2 id="handle_input"><a class="header" href="#handle_input"><code>handle_input</code></a></h2>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub fn handle_input(
app: &mut App,
timeout: std::time::Duration,
) -> std::io::Result<Action>
<span class="boring">}</span></code></pre></pre>
<p>Polls for keyboard input and dispatches to mode-specific handlers. Returns <code>Action::Quit</code> on <code>q</code>, <code>Esc</code> (in appropriate modes), or <code>Ctrl+C</code>.</p>
<h2 id="errors"><a class="header" href="#errors">Errors</a></h2>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub enum TowlTuiError {
Io(std::io::Error),
}
<span class="boring">}</span></code></pre></pre>
<p>Terminal I/O errors from crossterm or ratatui operations.</p>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<a rel="prev" href="../api/processor.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../api/types.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../api/processor.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../api/types.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<script>
window.playground_copyable = true;
</script>
<script src="../elasticlunr.min.js"></script>
<script src="../mark.min.js"></script>
<script src="../searcher.js"></script>
<script src="../clipboard.min.js"></script>
<script src="../highlight.js"></script>
<script src="../book.js"></script>
</div>
</body>
</html>