Skip to content

Terminal UI

Maggus uses a full-screen terminal UI built with Bubble Tea and Lipgloss. Every interactive view runs inside a bordered box with a status bar at the bottom showing available keyboard shortcuts.

When Claude 2x mode is active, the logo and borders turn yellow and a countdown timer is displayed.

When you run maggus without any arguments in a terminal, the interactive main menu launches.

Main Menu

Layout

The menu screen shows:

  • Logo and version at the top, centered
  • Plan summaryN plans · N tasks · N done · N blocked (or "No plans found")
  • Current directory displayed below the summary
  • Menu items grouped by category
  • Status bar at the bottom with navigation hints

When an update is available, a green banner appears below the summary.

Items are grouped into four categories:

Shortcut hints

Hold Alt to briefly reveal underlined shortcut characters on each menu item. The underlines auto-hide after 1.5 seconds.

Core Workflow

ItemShortcutDescription
workalt+wWork on the next N tasks from the implementation plan
statusalt+sShow a compact summary of plan progress
listalt+lPreview upcoming workable tasks

Repository Management

ItemShortcutDescription
reposalt+rManage configured repositories

AI-Assisted Creation

These items only appear when Claude Code is installed.

ItemShortcutDescription
visionalt+vCreate or improve VISION.md
architecturealt+aCreate or improve ARCHITECTURE.md
planalt+pCreate an implementation plan

Project Management

ItemShortcutDescription
configalt+cEdit project settings interactively
worktreealt+tManage Maggus worktrees
releasealt+zGenerate RELEASE.md with changelog
cleanalt+nRemove completed plans and finished runs
updatealt+uCheck for and install updates
initalt+iInitialize a .maggus project (only shown when not yet initialized)
KeyAction
Up / DownMove through menu items
EnterSelect the highlighted item
Home / EndJump to first / last item
Alt + shortcutJump directly to an item (e.g. Alt+w for work)
q / Esc / Ctrl+CExit Maggus

Some commands open a sub-menu where you configure options before running. Currently work and worktree have sub-menus.

Work Sub-Menu

Work Sub-Menu

OptionValuesDefault
Tasks1, 3, 5, 10, all3
Worktreeoff, onoff

Worktree Sub-Menu

OptionValuesDefault
Actionlist, cleanlist
KeyAction
Up / Down or j / kMove between options
Left / Right or h / lCycle option values
EnterCycle value (on option row) or confirm (on Run)
Home / EndJump to first / last row
q / EscBack to main menu
Ctrl+CQuit

Auto-Update

Maggus checks for updates on startup (non-blocking). The behavior depends on the auto_update setting in your global config (~/.maggus/config.yml):

ModeBehavior
offNo update check
notifyShows a banner when an update is available
autoDownloads and applies updates automatically

See Configuration for details on setting the update mode.


Work View

The work view displays while maggus work is running. A tab bar at the top lets you switch between four views.

Progress Tab

Shows the current task status, output summary, tool count, model, elapsed time, and token usage.

Work Progress View

Detail Tab

A scrollable log of every tool invocation with timestamps and file paths.

Work Detail View

Task Tab

The current task's description and acceptance criteria with completion status.

Commits Tab

List of commits made during the current run.

Keyboard Shortcuts

KeyAction
Left / Right or 1-4Switch tabs
Up / DownScroll detail log (on Detail tab)
Home / EndJump to top/bottom of detail log
Alt+SStop after current task (with confirmation)
Alt+S (when stopping)Cancel the stop and resume
Ctrl+CInterrupt immediately

Stop After Task

Press Alt+S during execution to request a graceful stop after the current task completes. A confirmation prompt appears: Stop after current task? (y/n). When active, the box border turns yellow as a visual indicator. Press Alt+S again to revert and continue.

Summary Screen

After all tasks complete (or the run is stopped/interrupted), a summary screen shows run details, token usage per task, commits, and remaining tasks. The title reflects the stop reason:

TitleWhen
Work CompleteAll requested tasks finished successfully
Stopped by UserUser pressed Alt+S to stop after a task
Work InterruptedUser pressed Ctrl+C during execution
Work FailedA task or commit failed (shows error detail)
No Tasks AvailableNo workable tasks found

From the summary screen you can choose Exit or Run again (with a custom task count).


Status View

The status view shows plan progress with tabbed plan sections, progress bars, and task lists.

Status View

Keyboard Shortcuts

KeyAction
Tab / Shift+TabSwitch between plans
Up / DownNavigate tasks
EnterOpen task detail view
Alt+AToggle showing all tasks vs. only incomplete
Alt+IIgnore/unignore the selected task
Alt+PIgnore/unignore the selected plan
Alt+RRun the selected task
Alt+BackspaceDelete the selected task (with confirmation)
q / EscExit

Task Detail

Press Enter on any task to open a detail view showing its plan file, status, criteria summary, description, and acceptance criteria.

Task Detail

KeyAction
PgUp / PgDnPrevious/next task
TabEnter criteria mode (for blocked tasks)
Alt+IIgnore/unignore the task
Alt+RRun the task
Alt+BackspaceDelete the task
EscBack to task list
qExit

Managing Blocked Tasks

When viewing a task with blocked criteria, press Tab to enter criteria mode. Navigate between blocked criteria with Up/Down and press Enter to open the action picker.

Blocked Handling

The action picker offers four options:

ActionDescription
UnblockRemoves the BLOCKED: prefix, turning it back into a normal unchecked criterion
ResolveMarks the criterion as done (removes the block and checks it)
DeleteRemoves the criterion entirely from the plan file
SkipLeaves the criterion unchanged

Changes are applied immediately to the plan file. Press Esc to go back.


List View

The list view shows all incomplete tasks with their source plan file.

List View

Keyboard Shortcuts

KeyAction
Up / DownNavigate tasks
EnterOpen task detail view
Alt+RRun the selected task
Alt+BackspaceDelete the selected task
q / EscExit

Blocked tasks are shown with a icon. The task detail view works the same as in the Status View, including criteria mode for managing blocked items.