Merge pull request #18 from Spacecraft-Software/tui-about

feat(vault-tui): About overlay (Standard §13.2)

Author: UnbreakableMJ

CHANGELOG.md

@@ -10,6 +10,16 @@ range may break in any release.
 
 ### Added
 
+- **TUI About overlay.** `vault-tui` gains a read-only About screen (open with
+  `?` or `:about`, dismiss with `Esc`/`q`) showing the version, maintainer,
+  copyright/license, and canonical URL — rendered from the same
+  `ATTRIBUTION`/`PKG_VERSION` constants as `vault-tui --version`, so it can't
+  drift. This was the last unfilled v0.1 success criterion that the Standard
+  §13.2 block appears "in `--version`, `--help`, README, **and the TUI About
+  screen**" (PRD §14). New `InputMode::About` + `render_about` (modeled on the
+  generator overlay); a `TestBackend` test asserts the §13.2 content reaches the
+  screen.
+
 - **`clipboard.backend` selection.** New config key choosing how the TUI's copy
   keys reach a clipboard: `auto` (default — native `arboard`, else the TUI falls
   back to OSC52), `arboard` (force native; warns if unavailable), or `osc52`

README.md

@@ -20,7 +20,8 @@ agent: `status` / `unlock` / `lock` / `sync` / `list` / `get` / `add` /
 `edit` / `remove` / `generate` / `stop-agent` on the CLI (with `--json`
 everywhere), and a three-pane `vault-tui` with search, reveal/copy
 (agent-side clipboard, 30 s auto-clear), a generator overlay, a `:` command
-line, and add/edit/delete. The CLI auto-starts the agent when needed, and
+line, add/edit/delete, and an About overlay (`?` / `:about`). The CLI
+auto-starts the agent when needed, and
 once you've unlocked online at least once, `unlock` also works **offline**
 from an encrypted local cache (read/copy from cache; sync and edits need the
 network). See [PRD §12](./PRD.md#12-milestones) for the roadmap (M0 → v0.1)

crates/vault-tui/src/app.rs

@@ -210,6 +210,8 @@ pub enum InputMode {
     ConfirmDelete,
     /// The agent is locked — keys edit the master-password / PIN entry.
     Unlock,
+    /// `?` pressed — the read-only About overlay is open.
+    About,
 }
 
 /// Which pane currently takes navigation keys.
@@ -1051,7 +1053,10 @@ impl App {
                 .and_then(FormState::focused_field_mut)
                 .map(|f| &mut f.value),
             InputMode::Unlock => self.unlock.as_mut().map(|u| &mut u.secret),
-            InputMode::Normal | InputMode::Generate | InputMode::ConfirmDelete => None,
+            InputMode::Normal
+            | InputMode::Generate
+            | InputMode::ConfirmDelete
+            | InputMode::About => None,
         }
     }
 
@@ -1180,6 +1185,16 @@ impl App {
         self.mode = InputMode::Normal;
     }
 
+    /// Open the read-only About overlay (`?` / `:about`).
+    pub const fn open_about(&mut self) {
+        self.mode = InputMode::About;
+    }
+
+    /// Close the About overlay, back to browsing.
+    pub const fn close_about(&mut self) {
+        self.mode = InputMode::Normal;
+    }
+
     /// Replace the overlay's password with a fresh one under the same options.
     pub fn regenerate(&mut self) {
         if let Some(g) = self.generator.as_mut() {
@@ -1777,6 +1792,15 @@ mod tests {
         assert!(app.command.is_empty());
     }
 
+    #[test]
+    fn about_overlay_open_and_close() {
+        let mut app = App::browsing(status(), vec![entry("a", None)]);
+        app.open_about();
+        assert_eq!(app.mode, InputMode::About);
+        app.close_about();
+        assert_eq!(app.mode, InputMode::Normal);
+    }
+
     #[test]
     fn generator_opens_with_defaults_and_regenerates() {
         let mut app = App::browsing(status(), vec![entry("a", None)]);

crates/vault-tui/src/main.rs

@@ -43,16 +43,17 @@ use vault_ipc::{default_socket_path, sanitize_socket_path};
 
 use app::{App, FormKind, FormSubmit, InputMode, RevealedSecret, UnlockState};
 
-const PKG_VERSION: &str = env!("CARGO_PKG_VERSION");
+pub(crate) const PKG_VERSION: &str = env!("CARGO_PKG_VERSION");
 
 /// Seconds before the TUI's own OSC52 fallback clear fires. Agent-side copies
 /// use the agent's configured default (`--clipboard-clear-secs`, reported back
 /// in `Response::Copied`); this constant only governs the terminal-clipboard
 /// path, where the TUI runs the timer itself.
 const COPY_CLEAR_SECS: u64 = 30;
 
-/// Standard §13.2 attribution block — surfaced via `--version` and `--help`.
-const ATTRIBUTION: &str = "\
+/// Standard §13.2 attribution block — surfaced via `--version`, `--help`, and
+/// the TUI About overlay (`?` / `:about`).
+pub(crate) const ATTRIBUTION: &str = "\
 Maintained by Mohamed Hammad <Mohamed.Hammad@SpacecraftSoftware.org>
 Copyright (C) 2026 Mohamed Hammad & Spacecraft Software  |  License: GPL-3.0-or-later
 https://Vault.SpacecraftSoftware.org/";
@@ -248,6 +249,7 @@ async fn handle_key(state: &mut App, key: KeyEvent, socket: &Path) {
         InputMode::Form => handle_form_key(state, key, socket).await,
         InputMode::ConfirmDelete => handle_confirm_key(state, key, socket).await,
         InputMode::Unlock => handle_unlock_key(state, key, socket).await,
+        InputMode::About => handle_about_key(state, key),
     }
 }
 
@@ -319,6 +321,15 @@ async fn handle_normal_key(state: &mut App, key: KeyEvent, socket: &Path) {
         KeyCode::Char('a') => state.open_add_form(),
         KeyCode::Char('e') => state.open_edit_form(),
         KeyCode::Char('d') => state.open_confirm_delete(),
+        KeyCode::Char('?') => state.open_about(),
+        _ => {}
+    }
+}
+
+/// About-overlay keys — read-only; any of these dismiss it.
+const fn handle_about_key(state: &mut App, key: KeyEvent) {
+    match key.code {
+        KeyCode::Esc | KeyCode::Enter | KeyCode::Char('q' | '?') => state.close_about(),
         _ => {}
     }
 }
@@ -540,7 +551,10 @@ async fn execute_command(state: &mut App, socket: &Path, cmd: &str) {
                 Err(e) => state.set_toast(e.to_string()),
             }
         }
-        other => state.set_toast(format!("unknown command: {other} (q · r · sync · lock)")),
+        "about" => state.open_about(),
+        other => state.set_toast(format!(
+            "unknown command: {other} (q · r · sync · lock · about)"
+        )),
     }
 }
 

crates/vault-tui/src/ui.rs

@@ -77,6 +77,7 @@ pub fn render(frame: &mut Frame, app: &App) {
         InputMode::Generate => render_generator(frame, app, body),
         InputMode::Form => render_form(frame, app, body),
         InputMode::ConfirmDelete => render_confirm(frame, app, body),
+        InputMode::About => render_about(frame, body),
         InputMode::Normal | InputMode::Search | InputMode::Command | InputMode::Unlock => {}
     }
     render_status_bar(frame, app, status_bar);
@@ -310,6 +311,49 @@ const fn onoff(b: bool) -> &'static str {
     if b { "on" } else { "off" }
 }
 
+/// Centered read-only About overlay (Standard §13.2), drawn over the browser.
+/// Renders from `crate::PKG_VERSION` + `crate::ATTRIBUTION` so it can't drift
+/// from `vault-tui --version`.
+fn render_about(frame: &mut Frame, area: Rect) {
+    let amber = hex(steelbore::MOLTEN_AMBER);
+    let steel = hex(steelbore::STEEL_BLUE);
+    let info = hex(steelbore::INFO);
+    let mut lines = vec![
+        Line::from(""),
+        Line::from(Span::styled(
+            format!("Vault v{}", crate::PKG_VERSION),
+            Style::default().fg(amber).add_modifier(Modifier::BOLD),
+        )),
+        Line::from(""),
+    ];
+    lines.extend(
+        crate::ATTRIBUTION
+            .lines()
+            .map(|l| Line::from(Span::styled(l.to_owned(), Style::default().fg(info)))),
+    );
+    lines.push(Line::from(""));
+    lines.push(Line::from(Span::styled(
+        "Esc close",
+        Style::default().fg(steel).add_modifier(Modifier::ITALIC),
+    )));
+    let block = Block::default()
+        .borders(Borders::ALL)
+        .border_style(Style::default().fg(amber))
+        .title(" About ")
+        .style(Style::default().bg(hex(steelbore::VOID_NAVY)));
+    // Wider/taller than the generator overlay so the long §13.2 lines fit
+    // without clipping the URL or hint.
+    let overlay = centered(area, 80, 60);
+    frame.render_widget(ratatui::widgets::Clear, overlay);
+    frame.render_widget(
+        Paragraph::new(lines)
+            .alignment(Alignment::Center)
+            .wrap(Wrap { trim: true })
+            .block(block),
+        overlay,
+    );
+}
+
 /// Centered add/edit form overlay, drawn over the browser.
 fn render_form(frame: &mut Frame, app: &App, area: Rect) {
     let Some(form) = app.form.as_ref() else {
@@ -450,7 +494,8 @@ fn render_status_bar(frame: &mut Frame, app: &App, area: Rect) {
         | InputMode::Generate
         | InputMode::Form
         | InputMode::ConfirmDelete
-        | InputMode::Unlock => None,
+        | InputMode::Unlock
+        | InputMode::About => None,
     };
     if let Some(input) = editing {
         spans.push(Span::styled(
@@ -770,4 +815,28 @@ mod tests {
         assert!(text.contains(&pw), "generated password missing:\n{text}");
         assert!(text.contains("Length 20"), "options line missing:\n{text}");
     }
+
+    #[test]
+    fn about_overlay_renders_attribution() {
+        let mut app = App::browsing(status(), vec![login_entry()]);
+        app.open_about();
+        let text = draw(&app);
+        assert!(text.contains("About"), "overlay title missing:\n{text}");
+        assert!(
+            text.contains(&format!("v{}", crate::PKG_VERSION)),
+            "version missing:\n{text}"
+        );
+        assert!(
+            text.contains("Mohamed Hammad"),
+            "maintainer missing:\n{text}"
+        );
+        assert!(
+            text.contains("GPL-3.0-or-later"),
+            "license missing:\n{text}"
+        );
+        assert!(
+            text.contains("SpacecraftSoftware.org"),
+            "URL missing:\n{text}"
+        );
+    }
 }