feat(tui): Help screen and keyboard shortcut reference overlay by jaeko44 · Pull Request #453 · virtengine/bosun

jaeko44 · 2026-03-26T09:22:15Z

Task-ID: eb0893c6-b815-4699-b19b-0504e2016917\n\nAutomated PR for task eb0893c6-b815-4699-b19b-0504e2016917\n\n---\n\nBosun-Origin: created

Copilot

Pull request overview

Adds a TUI help/keyboard-shortcuts overlay and replaces per-screen inline shortcut footers with a centralized, dynamic footer-hints system.

Changes:

Introduces ui/tui/HelpScreen.js (shortcut groups, help overlay UI, and getFooterHints()).
Updates Tasks/Agents screens to publish footer hints via onFooterHintsChange instead of rendering their own footer blocks.
Adds help overlay + footer rendering to both UI TUI (ui/tui/App.js) and CLI TUI (tui/app.mjs), and updates tests/harness accordingly.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
ui/tui/TasksScreen.js	Removes inline shortcut footers; emits contextual footer hints via `onFooterHintsChange(getFooterHints(...))`.
ui/tui/HelpScreen.js	New help overlay UI + shortcut catalog + `getFooterHints()` helper for dynamic footer content.
ui/tui/App.js	Adds help overlay toggling/scroll handling and a shared footer-hints renderer.
tui/screens/agents.mjs	Removes inline footer block; emits contextual footer hints via `onFooterHintsChange(getFooterHints(...))`.
tui/app.mjs	Adds help overlay toggling and app-level footer rendering; wires `onFooterHintsChange` into screens.
tests/tui/screens.test.mjs	Adjusts assertions for new footer/help output; adds tests for help overlay and dynamic footer hints.
tests/tui/render-ink.mjs	Adds `latestText()` helper to reduce multi-frame output noise in tests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tui/app.mjs

Copilot · 2026-03-26T09:28:17Z

tests/tui/render-ink.mjs

+    latestText() {
+      const cleaned = stripAnsi(buffer).replace(/\r/g, "");
+      const lastIndex = cleaned.lastIndexOf("Agents:");
+      return lastIndex >= 0 ? cleaned.slice(lastIndex) : cleaned;
+    },


latestText() is coupled to the literal string "Agents:" (from StatusHeader row1). This makes the test harness brittle to unrelated header text changes. Consider deriving the “latest frame” boundary from Ink’s clear-screen sequences in the raw buffer, or introducing an explicit frame delimiter, instead of hardcoding a header substring.

tui/app.mjs

ui/tui/App.js

tui/app.mjs

Copilot · 2026-03-26T09:28:18Z

tui/app.mjs

+    if (helpOpen) {
+      if (key?.escape) {
+        setHelpOpen(false);
+        return;
+      }
+      if (key?.upArrow) {
+        setHelpScrollOffset((current) => Math.max(0, current - 1));
+        return;
+      }
+      if (key?.downArrow) {
+        setHelpScrollOffset((current) => current + 1);
+        return;
+      }


Help overlay scrolling isn’t bounded: down-arrow always increments helpScrollOffset, so it can grow beyond the number of help rows and render an empty/blank help list. Compute a max scroll offset (based on the help content + available terminal rows) and clamp both up/down updates to keep the overlay usable.

Copilot · 2026-03-26T09:28:18Z

tui/app.mjs

@@ -233,7 +263,18 @@ export default function App({ host, port, connectOnly, initialScreen, refreshMs,
          refreshMs=${refreshMs}
          onTasksChange=${setTasks}
          onInputCaptureChange=${setScreenInputLocked}
+          onFooterHintsChange=${setFooterHints}
        />
+        ${helpOpen
+          ? html`
+              <${Box} flexDirection="column" marginTop=${1}>
+                <${HelpScreen} scrollOffset=${helpScrollOffset} maxRows=${helpRows} />
+              <//>
+            `
+          : null}
+      <//>
+      <${Box} paddingX=${1}>
+        <${Text} dimColor>${footerText}<//>


When toggling help with '?', the CLI TUI doesn’t reset scroll position or override footer hints with the help-specific hints (unlike ui/tui/App.js). As a result, the footer can continue showing screen hints while the overlay is open, and reopening help may start at a stale scroll offset. Consider resetting helpScrollOffset on open/close and rendering footer hints from getFooterHints(screen, { helpOpen: true }) while help is open.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…t-tui-help-screen-and-keyboard-shortcut-refer

…screen-and-keyboard-shortcut-refer' into task/eb0893c6b815-feat-tui-help-screen-and-keyboard-shortcut-refer

github-actions · 2026-03-26T10:42:12Z

Bosun CI signal: Bosun-created PR currently has failing checks.

Automation scope: Bosun-created
Workflow: CI
Conclusion: failure
Run: https://github.com/virtengine/bosun/actions/runs/23598672823
Head SHA: 049641f
Failed jobs: Build + Tests

…eyboard-shortcut-refer

github-actions · 2026-03-26T12:20:47Z

Bosun PR classification: Bosun-created.
This PR is tracked by Bosun attachment automation.

PR class label: bosun-pr-bosun-created
Attach label: bosun-attached (yes, because Bosun-created PRs remain attached regardless of human PR attach mode)
Attach mode policy: all
Trusted author: no
Bosun-created label present: yes
Automation scope: Eligible for Bosun repair and merge automation (Bosun-created PR).
CI failure signal label: bosun-needs-fix
CI failure marker:
Trigger: pull_request_target / synchronize

Co-authored-by: bosun-ve[bot] <262908237+bosun-ve[bot]@users.noreply.github.com>

chore: auto-commit agent work (eb0893c6-b81)

ef44101

Copilot AI review requested due to automatic review settings March 26, 2026 09:22

jaeko44 added the bosun-attached Bosun PR attachment marker label Mar 26, 2026

github-actions bot added the bosun-pr-public PR observed by Bosun but not trusted for high-risk automation label Mar 26, 2026

Copilot started reviewing on behalf of jaeko44 March 26, 2026 09:22 View session

Copilot AI reviewed Mar 26, 2026

View reviewed changes

jaeko44 added the bosun-needs-fix Attached PR with failing CI that Bosun should pick up for repair label Mar 26, 2026

jaeko44 and others added 4 commits March 26, 2026 21:07

Update tui/app.mjs

8dbdb88

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update tui/app.mjs

a824e6d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update tui/app.mjs

942b30d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update ui/tui/App.js

b4d5c8e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

jaeko44 added bosun-pr-bosun-created PR created by Bosun and eligible for Bosun automation and removed bosun-pr-public PR observed by Bosun but not trusted for high-risk automation labels Mar 26, 2026

jaeko44 added 2 commits March 26, 2026 21:38

Merge remote-tracking branch 'origin/main' into task/eb0893c6b815-fea…

ff6ffe4

…t-tui-help-screen-and-keyboard-shortcut-refer

Merge remote-tracking branch 'origin/task/eb0893c6b815-feat-tui-help-…

ab2f8b5

…screen-and-keyboard-shortcut-refer' into task/eb0893c6b815-feat-tui-help-screen-and-keyboard-shortcut-refer

github-actions bot removed the bosun-needs-fix Attached PR with failing CI that Bosun should pick up for repair label Mar 26, 2026

Merge branch 'main' into task/eb0893c6b815-feat-tui-help-screen-and-k…

5952ca1

…eyboard-shortcut-refer

github-actions bot added the bosun-needs-fix Attached PR with failing CI that Bosun should pick up for repair label Mar 26, 2026

Merge branch 'main' into task/eb0893c6b815-feat-tui-help-screen-and-k…

d1b9726

…eyboard-shortcut-refer

jaeko44 added 2 commits March 26, 2026 23:42

Merge remote-tracking branch 'origin/main' into HEAD

57729a2

Co-authored-by: bosun-ve[bot] <262908237+bosun-ve[bot]@users.noreply.github.com>

Merge remote-tracking branch 'origin/main' into HEAD

049641f

Co-authored-by: bosun-ve[bot] <262908237+bosun-ve[bot]@users.noreply.github.com>

jaeko44 enabled auto-merge March 26, 2026 15:47

jaeko44 added bosun-needs-fix Attached PR with failing CI that Bosun should pick up for repair and removed bosun-needs-fix Attached PR with failing CI that Bosun should pick up for repair labels Mar 26, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(tui): Help screen and keyboard shortcut reference overlay#453

feat(tui): Help screen and keyboard shortcut reference overlay#453
jaeko44 wants to merge 11 commits intomainfrom
task/eb0893c6b815-feat-tui-help-screen-and-keyboard-shortcut-refer

jaeko44 commented Mar 26, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Mar 26, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 26, 2026

Uh oh!

Copilot AI Mar 26, 2026

Uh oh!

github-actions bot commented Mar 26, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

jaeko44 commented Mar 26, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions bot commented Mar 26, 2026 •

edited

Loading