This repository has been archived on 2026-10-25. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
submarine/docs
Simon FrankenandClaude Opus 5.5 6e1236d495 Show a muted "in sync" for submodules without issues
An empty status cell could be read as missing data. The muted word
confirms the check ran without drawing attention. The word is defined
once in the theme and shared with the detail pane.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-21 16:18:17 +02:00
..

submarine — documentation

submarine is a terminal UI for git repositories with many (recursively nested) submodules. It shows only the submodules, as a collapsible tree, and describes each pin as a branch plus distance (origin/main ↓1) instead of a bare commit hash.

Documents

Document Contents
requirements.md What the tool must do: functional and non-functional requirements
state-model.md How a submodule's state is determined, summarized into issues, and how pins are resolved to refs
ux-guide.md Layout, attention hierarchy, colors, wording, navigation and key bindings
architecture.md Package layout, the provider boundary, async loading, testing
decisions.md Decision log with rationale (ADR style)

Status

Prototype. The UI is complete for browsing. It reads real repositories through a git provider (internal/submodule/git): submarine [dir]. It fetches in the background on startup (--no-fetch to skip; f to fetch again) and follows changes made in other shells. submarine --mock shows the built-in mock data (internal/submodule/mock). The actions u, b, /, ! only show a "not implemented" message.

Next steps, roughly in order:

  1. Actions: checkout pin (submodule update), bump pin to tip, init.
  2. Filter (/) and "problems only" (!) views.