submarine/docs

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)

Install

curl -fsSL https://git.simon-franken.de/simonfranken/submarine/raw/branch/main/install.sh | sh

Installs submarine and the alias sub (linux/macOS, amd64/arm64) to ~/.local/bin. Update with submarine update. Maintainers publish with GITEA_TOKEN=… make release (see architecture).

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. "Problems only" (!) view; it can reuse the tree's filter.