Skip to content

[docs] Update documentation for TUI keyboard shortcuts from v2.1.0 #70

@github-actions

Description

@github-actions

Documentation Updates — 2026-03-18

This PR updates the documentation based on features merged in the last 24 hours (v2.1.0 release).

Features Documented

Changes Made

  • Updated docs/commands.md to add a Keyboard shortcuts section under agentrc tui, documenting all interactive controls:
    • Main menu: G (Generate), R (Readiness), E (Eval), B (Batch), M (Model), J (Judge), Q (Quit)
    • Generate submenu: C (copilot-instructions.md), A (AGENTS.md), N (nested areas), Esc (back)
    • Eval submenu: R (run), I (init), B/Esc (back)
    • Batch submenu: G (GitHub), A (Azure DevOps), B/Esc (back)
    • Preview / confirm controls: S (save), D (discard), Y (overwrite), Q (quit)

Merged PRs Referenced

Notes

The docs rewrite in #62 documented all flags and options for every command but left the agentrc tui section without any keyboard shortcut reference. The R→Readiness and N→Nested shortcuts introduced/changed in #55 were verified against src/ui/tui.tsx.

Generated by Daily Documentation Updater ·

  • expires on Mar 19, 2026, 11:52 PM UTC

Note

This was originally intended as a pull request, but GitHub Actions is not permitted to create or approve pull requests in this repository.
The changes have been pushed to branch docs/tui-keyboard-shortcuts-ea338d50486efe0c.

Click here to create the pull request

To fix the permissions issue, go to SettingsActionsGeneral and enable Allow GitHub Actions to create and approve pull requests.

Show patch preview (82 of 82 lines)
From 26e0dd8c720657f4b6b01a7150ef5489ff70e1b5 Mon Sep 17 00:00:00 2001
From: GitHub Copilot <copilot@github.com>
Date: Wed, 18 Mar 2026 23:51:21 +0000
Subject: [PATCH] docs: add TUI keyboard shortcuts to commands reference

Document the interactive keyboard shortcuts for `agentrc tui`, including
the main menu (G/R/E/B/M/J/Q), generate submenu (C/A/N), eval submenu
(R/I), batch submenu (G/A), and preview controls (S/D/Y/Q).

The R key for readiness and N key for nested area instructions were
updated in #55 but were not reflected in the docs rewrite (#62).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
 docs/commands.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/docs/commands.md b/docs/commands.md
index 482da3c..5c9892a 100644
--- a/docs/commands.md
+++ b/docs/commands.md
@@ -207,6 +207,56 @@ agentrc tui
 | `--repo <path>`  | cwd     | Repository path      |
 | `--no-animation` |         | Skip animated banner |
 
+### Keyboard shortcuts
+
+Once inside the TUI, use keyboard shortcuts to navigate:
+
+**Main menu**
+
+| Key | Action                            |
+| --- | --------------------------------- |
+| `G` | Generate instructions / configs   |
+| `R` | Run readiness report              |
+| `E` | Eval menu                         |
+| `B` | Batch menu                        |
+| `M` | Change eval model                 |
+| `J` | Change judge model                |
+| `Q` | Quit                              |
+
+**Generate submenu**
+
+| Key   | Action                                       |
+| ----- | -------------------------------------------- |
+| `C`   | Generate `copilot-instructions.md`           |
+| `A`   | Generate `AGENTS.md`                         |
+| `N`   | Generate nested area instructions (monorepo) |
+| `Esc` | Back                                         |
+
+**Eval submenu**
+
+| Key     | Action              |
+| ------- | ------------------- |
+| `R`     | R
... (truncated)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions