git-ticket

git-ticket is a bug tracker that:

• is fully embedded in git: you only need your git repository to have a bug tracker
• is distributed: use your normal git remote to collaborate, push and pull your bugs!
• works offline: in a plane or under the sea? Keep reading and writing bugs!
• prevents vendor lock-in: your usual service is down or went bad? You already have a full backup.
• is fast: listing bugs or opening them is a matter of milliseconds
• doesn't pollute your project: no files are added in your project
• integrates with your tooling: use the UI you like (CLI, terminal, web) or integrate with your existing tools through the CLI or the GraphQL API
• bridges to other bug trackers: use bridges to import and export to other trackers.

🚧 This is now more than a proof of concept, but still not fully stable. Expect dragons and unfinished business. 🚧

Installation

git clone git@github.com:daedaleanai/git-ticket.git
make install

If it's not done already, add the golang binary directory in your PATH:

export PATH=$PATH:$(go env GOROOT)/bin:$(go env GOPATH)/bin

Workflows

There are multiple ways to use git-bug:

CLI usage

Create a new identity:

git ticket user create

Create a new ticket:

git ticket add

Your favorite editor will open to write a title and a message.

You can push your new entry to a remote:

git ticket push [<remote>]

And pull for updates:

git ticket pull [<remote>]

List existing tickets:

git ticket ls

Filter and sort tickets using a query:

git ticket ls "status:open sort:edit"

You can now use commands like show, comment, open or close to display and modify tickets. For more details about each command, you can run git ticket <command> --help or read the command's documentation.

Interactive terminal UI

An interactive terminal UI is available using the command git ticket termui to browse and edit tickets.

Web UI

A simple experimental read-only web UI is available using the command git ticket webui to browse tickets on a kanban-style board. git ticket will expose the web UI on a local port (defaults to 3333, but can be changed using the --port parameter).

Filtering and Sorting

Tickets shown in the web UI can filtered and sorted by providing a query as the q URL parameter. See here for a documentation of the query language.

Coloring

In addition, the web UI also supports a color-by qualifier in queries to color tickets based on author, assignee or labels.

Bookmarks

Queries can be bookmarked by storing a JSON array with the following structure in the local git config key git-bug.webui.bookmarks. Bookmarks are organized in named groups, with each bookmark having a label and an associated query property.

[
    {
        "group": "me",
        "bookmarks": [
            {
                "label": "created",
                "query": "author:me"
            },
            {
                "label": "assigned",
                "query": "assignee:me"
            }
        ]
    },
    {
        "group": "milestones",
        "bookmarks": [
            {
                "label": "milestone 1",
                "query": "label:milestone-1"
            },
            {
                "label": "milestone 2",
                "query": "label:milestone-2"
            }
        ]
    }
]

Note: The git config value may not contain any newlines. E.g., the bookmarks from the above example can be configured by running the following command:

git config --local git-bug.webui.bookmarks '[ { "group": "me", "bookmarks": [ { "label": "created", "query": "author:me" }, { "label": "assigned", "query": "assignee:me" } ] }, { "group": "milestones", "bookmarks": [ { "label": "milestone 1", "query": "label:milestone-1" }, { "label": "milestone 2", "query": "label:milestone-2" } ] } ]'

Cross-References

The detailed ticket view supports rendering certain patterns in the ticket's title, description or comments as clickable links. This behavior is controlled by a set of rules, which can be configured via the git ticket config key webui. The configuration is a JSON object with a single key xref that contains a array of rule objects. Each rule consists of a regular expression (pattern) and a link template. Each match of a pattern is transformed to a clickable link. The link target is constructed by instantiating the link template associated with the pattern. The Nth capture groups of the regular expression can be referenced in the link template by using {{ index . N}} notation. Capture group 0 always refers to the full match.

The following examples create links for URLs and create links to the detailed ticked view of this web UI for ticket IDs, respectively, and can be set by running git ticket config webui.

{
  "xref": [
    {
      "pattern": "\\bhttps?://\\S+\\b",
      "link": "{{ index . 0 }}"
    },
    {
      "pattern": "\\b[a-f0-9]{7,64}\\b",
      "link": "/ticket?id={{ index . 0 }}"
    }
  ]
}

Internals

Interested by how it works ? Have a look at the data model and the internal bird-view.

Misc

• Bash completion
• Zsh completion
• PowerShell completion
• ManPages

Planned features

• media embedding
• more bridges
• extendable data model to support arbitrary bug tracker
• inflatable raptor

License

Unless otherwise stated, this project is released under the GPLv3 or later license © Michael Muré.

The git-bug logo by Viktor Teplov is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) license © Viktor Teplov.