Git-bug: A Distributed, Offline-First Bug Tracker Embedded in Git Repositories

Introduction to Git-bug

Git-bug is a bug tracking system designed to be fully embedded within a Git repository. It allows developers to manage bugs using their existing Git infrastructure, eliminating the need for separate bug tracking services. The system is distributed, enabling collaboration through standard Git push and pull operations.

Key Features and Workflow

A core feature of Git-bug is its offline capability, allowing users to read and write bug reports without an internet connection. It aims to prevent vendor lock-in by storing all bug data within the Git repository itself, providing a built-in backup. The tool is designed for speed, with bug listing and opening operations taking milliseconds.

Git-bug supports multiple workflows, including a native approach where bugs are pushed and pulled like code, and a bridge workflow for syncing with other bug trackers. It offers a command-line interface (CLI), an interactive terminal UI (git bug termui), and a web UI (git bug webui), with the web UI also planned for public portals with OAuth authentication.

Basic Usage

Users can create a new identity with `git bug user create` and add new bugs using `git bug add`. Bugs can be pushed to and pulled from remotes using `git bug push` and `git bug pull`. The `git bug ls` command lists existing bugs, with options for filtering and sorting. Further commands like `show`, `comment`, `open`, and `close` are available for managing bug details.

Integration and Extensibility

Git-bug does not add files to the project directory, maintaining a clean project structure. It integrates with existing tooling through its CLI and a GraphQL API. The system also includes bridges for importing and exporting data to and from other bug trackers, enhancing its interoperability.