Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rbong/vim-flog

A fast, beautiful, and powerful git branch viewer for vim.
https://github.com/rbong/vim-flog

fugitive git graph log plugin vim

Last synced: 3 months ago
JSON representation

A fast, beautiful, and powerful git branch viewer for vim.

Awesome Lists containing this project

README

        

# Flog

[![test status](https://github.com/rbong/vim-flog/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/rbong/vim-flog/actions)

Flog is a fast, beautiful, and powerful git branch viewer for Vim.

![flog in action](img/screen-graph.png)

## Prerequisites

In Vim 8/9, [LuaJIT 2.1](https://luajit.org/download.html) must be installed.

On systems without LuaJIT available, you may also use [Lua](https://www.lua.org/) 5.1,
however this is less performant.

Neovim is supported natively.

## Installation

If you use [Plug](https://github.com/junegunn/vim-plug), add the following to your `.vimrc`:

```vim
Plug 'tpope/vim-fugitive'
Plug 'rbong/vim-flog'
```

For lazy.nvim users:

```lua
{
"rbong/vim-flog",
lazy = true,
cmd = { "Flog", "Flogsplit", "Floggit" },
dependencies = {
"tpope/vim-fugitive",
},
},
```

## Using Flog

Basics:
- Open the git branch graph with `:Flog` or `:Flogsplit`.
- Many options can be passed in, complete with `` completion.
- Open commits in temporary windows once you've opened Flog using ``.
- Jump between commits with `` and ``.
- Refresh the git branch graph with `u`.
- Toggle viewing all branches with `a`.
- Quit with `gq`.
- See more mappings with `g?`.

Many of the mappings that work in the Fugitive `:Git` status window will work in Flog.

Run `:Git` commands in a split next to the git branch graph using `:Floggit -p`.
Command line completion is provided to do any git command with the commits and refs under the cursor.

Flog can be heavily customized with functions.
See [examples](EXAMPLES.md) for details.

## Getting Help

See [the issue tracker](https://github.com/rbong/vim-flog/issues), [the discussions board](https://github.com/rbong/vim-flog/discussions), and `:help flog`.

See [fugitive](https://github.com/tpope/vim-fugitive) for help with fugitive.

See `git log --help` for help with `git log`.

More info:
- [FAQ](FAQ.md)
- [Examples](EXAMPLES.md)
- [Contributing](CONTRIBUTING.md)