Documentation
¶
Overview ¶
Command lazydash is a keyboard-driven terminal UI for browsing and managing issues from one place: GitHub Projects boards and local git-native issues (issues stored in the repository under refs/issues/).
Run it inside a repository to work with local issues fully offline — create, comment, close, move and undo — or anywhere to browse and edit your GitHub Projects. It auto-detects which backends are available. See the README for keybindings and configuration.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
api
Package api is the GitHub Projects v2 data source: it wraps the go-gh GraphQL client and maps GitHub's schema onto lazydash's backend-neutral core model.
|
Package api is the GitHub Projects v2 data source: it wraps the go-gh GraphQL client and maps GitHub's schema onto lazydash's backend-neutral core model. |
|
cache
Package cache persists the last successfully-loaded board per project so a board stays browsable when its source is unreachable — a GitHub project you synced earlier can still be read offline.
|
Package cache persists the last successfully-loaded board per project so a board stays browsable when its source is unreachable — a GitHub project you synced earlier can still be read offline. |
|
core
Package core holds lazydash's backend-neutral domain model: the projects, boards, cards and fields that every source (GitHub Projects, local git issues) maps onto and that the TUI renders.
|
Package core holds lazydash's backend-neutral domain model: the projects, boards, cards and fields that every source (GitHub Projects, local git issues) maps onto and that the TUI renders. |
|
source
Package source defines the backend abstraction lazydash renders through.
|
Package source defines the backend abstraction lazydash renders through. |
|
source/github
Package github adapts the GitHub Projects v2 client (internal/api) to the source.Source interface: it resolves the viewer, aggregates user and org projects, applies the config include/exclude filters, and loads boards.
|
Package github adapts the GitHub Projects v2 client (internal/api) to the source.Source interface: it resolves the viewer, aggregates user and org projects, applies the config include/exclude filters, and loads boards. |
|
source/local
Package local is the offline backend: it reads (and later writes) git-native-issue issues stored as commit chains under refs/issues/ in the repository lazydash is launched in.
|
Package local is the offline backend: it reads (and later writes) git-native-issue issues stored as commit chains under refs/issues/ in the repository lazydash is launched in. |
|
tui/components/picker
Package picker is a modal single-choice list used to pick a field option (which column to move a card to, a priority, a state).
|
Package picker is a modal single-choice list used to pick a field option (which column to move a card to, a priority, a state). |
|
tui/components/prompt
Package prompt is a small modal text field used to collect a single- or multi-line value (an issue title, a comment, a label list).
|
Package prompt is a small modal text field used to collect a single- or multi-line value (an issue title, a comment, a label list). |
Click to show internal directories.
Click to hide internal directories.