README
¶
Overview
git-bug is a standalone, distributed, offline-first issue management tool that embeds issues, comments, and more as objects in a git repository (not files!), enabling you to push and pull them to one or more remotes.
Key Features
- Native Git Storage: Manage issues, users, and comments directly within your repository - keeping everything versioned and clutter-free
- Distributed & Versioned: Leverage Git’s decentralized architecture to work offline and sync seamlessly later
- Lightning Fast: List and search issues in mere milliseconds
- Third-Party Bridges: Easily synchronize issues with platforms like GitHub and GitLab using bridges
- Flexible Interfaces: Choose how you interact - via CLI, TUI, or a web browser
- Effortless Integration: Start managing issues your repository with minimal setup
Getting Started
- 🚩 Install: Check out
//:INSTALLATION.mdfor step-by-step installation instructions or explore the latest release to get started immediately. - 📃 Explore: Read the documentation to learn how to
use
git-bugeffectively - 💻 Contribute: Interested in hacking on
git-bug? Head over to//:CONTRIBUTING.mdand see how you can help shape the project - 💬 Connect: Chat with us live on Matrix at
#git-bug:matrix.org - 📚 Discuss: Browse existing discussions or start a new one to ask questions and share ideas
Our Community
git-bug thrives thanks to the passion of its contributors, the generosity of
independent backers, and the strategic support of our sponsors. Each
of you plays a crucial role in our journey, and we deeply appreciate every
contribution that helps drive our project forward.
Make a contribution to support this project and get featured below!
Backers ⭐
Sponsors 🌟
License
Unless otherwise stated, this project and all assets within it are released under GPLv3 or later, copyright Michael Muré.
The git-bug logo is authored by and copyright Viktor Teplov,
released under a CC BY 4.0 license.
This project and its vibrant community was initially dreamt up and built by Michael Muré.
Thank you for all of your hard work!
❤
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
auth
Package auth contains helpers for managing identities within the GraphQL API.
|
Package auth contains helpers for managing identities within the GraphQL API. |
|
graphql
Package graphql contains the root GraphQL http handler
|
Package graphql contains the root GraphQL http handler |
|
graphql/connections
Package connections implement a generic GraphQL relay connection
|
Package connections implement a generic GraphQL relay connection |
|
graphql/models
Package models contains the various GraphQL data models
|
Package models contains the various GraphQL data models |
|
graphql/resolvers
Package resolvers contains the various GraphQL resolvers
|
Package resolvers contains the various GraphQL resolvers |
|
Package bridge contains the high-level public functions to use and manage bridges
|
Package bridge contains the high-level public functions to use and manage bridges |
|
core
Package core contains the target-agnostic code to define and run a bridge
|
Package core contains the target-agnostic code to define and run a bridge |
|
github
Package github contains the Github bridge implementation
|
Package github contains the Github bridge implementation |
|
jira
Package jira contains the Jira bridge implementation
|
Package jira contains the Jira bridge implementation |
|
launchpad
Package launchpad contains the Launchpad bridge implementation
|
Package launchpad contains the Launchpad bridge implementation |
|
Package cache contains a caching layer on top of the low-level bug and identity functions to provide efficient querying, filtering, sorting.
|
Package cache contains a caching layer on top of the low-level bug and identity functions to provide efficient querying, filtering, sorting. |
|
Package commands contains the CLI commands
|
Package commands contains the CLI commands |
|
input
Package input contains helpers to use a text editor as an input for various field of a bug
|
Package input contains helpers to use a text editor as an input for various field of a bug |
|
entities
|
|
|
bug
Package bug contains the bug data model and low-level related functions
|
Package bug contains the bug data model and low-level related functions |
|
identity
Package identity contains the identity data model and low-level related functions
|
Package identity contains the identity data model and low-level related functions |
|
dag
Package dag contains the base common code to define an entity stored in a chain of git objects, supporting actions like Push, Pull and Merge.
|
Package dag contains the base common code to define an entity stored in a chain of git objects, supporting actions like Push, Pull and Merge. |
|
internal
|
|
|
misc
|
|
|
completion
command
|
|
|
random_bugs/cmd
command
|
|
|
Package repository contains helper methods for working with a Git repo.
|
Package repository contains helper methods for working with a Git repo. |
|
Package termui contains the interactive terminal UI
|
Package termui contains the interactive terminal UI |
|
util
|
|
Click to show internal directories.
Click to hide internal directories.