fugitive ·

Simple command line tool to make git more intuitive, along with useful GitHub addons.

fugitive provides new or alternative commands to use with git, and alsoadds a few helpful tools for GitHub repositories.

It's similar to git-extras but is designed to be moreportable. git-extras is written entirely as a set of shell scripts,which means platform support outside Unix is at best hit or miss.

On the other hand, fugitive is written in Nim to allow for betterportability. Other benefits are that Nim is super fast, flexible, and morereadable than the often cryptic bash syntax.

Git Town is a project with similar goals written in Go.

installation

Linux, Windows, and macOS prebuilt binaries are available from releases.Download the file for your system from the latest release and extract the binarywithin to somewhere in your $PATH.

Alternatively if you have Nim and Nimble installed( and ~/.nimble/bin is in your path ), you can also simply run:

nimble install fugitive

This will make the latest version of fugitive available to you anywhere.Check out Nimble if you'd like to know more about package installation.

usage

Usage: fugitive [command] [...args] (...options)

Commands:
  alias     [name [--remove|-r]] [expansion]
                                 List, add, or remove git aliases
  config    [key] [value] [--remove|-r]
                                 Set, update, or remove fugitive settings
  changelog [file] [--tag|-t:<tag>] [--last-tag|-l:<tag>] [--overwrite|-o]
            [--no-anchor] [--no-title] [--no-divider] [--init]
                                 Write a list of changes since last tag or between two tags
  clone     <...repos>           Alias for `fugitive mirror`
  install   [--override|-o] [--force|-y]
                                 Alias various fugitive commands as git subcommands
  lock      <...files>           Prevent changes to the specified files from being tracked
  mirror    <...repos>           Wrapper around `git clone` with various URL shorthands
  open      [repo]               Open the current or specified repository's homepage
  profile   [username]           View a summary of a GitHub user profile
  release   <tag> [--repo|-r:<repo>] [--file|-f:<filepath>] [--description|-d:<desc>]
            [--desc-file|-D:<filepath>] [--draft|-N] [--prerelease|-p]
            [--target-commit|-T:<commitish>]
                                 Create a GitHub release and/or upload assets to a release
  scrap     <...files>  [--all|-a]
                                 Discard local changes to the specified files
  summary                        Summarize git repository statistics
  undo      [#] [--hard|-h]      Undo the last commit ( or last # commits )
  uninstall                      Remove git aliases added by `install`
  unlock    <...files>           Resume tracking changes to these locked files
  unstage   <...files> [--all|-a]
                                 Remove files from the git stage area

Options:
  --help, -h       Show this help message
  --version, -v    Output the fugitive version number

For help on a specific command, provide the --help/-h flag afterthat command, ie. fugitive changelog -h.

configuration

fugitive stores a configuration file in your user configuration directorycalled fugitive.ini. You can manage this file using the fugitive configcommand.

TIP: Using the fugitive config command with no arguments will print the fullfilepath to your config file.

You can, for example, tell fugitive explicitly what to use as your GitHubusername when using various shorthand features:

fugitive config github.username <name>

Here's the full list of available settings:

Settings of the type bool are retrieved using Nim's parseBool,so they can be set to any of y, yes, true, 1, on or n, no, false, 0, off.

username

Some commands support a shorthand for referring to GitHub repositories,provided you've configured your GitHub username or it can be inferredfrom your git config.

<name>

The simplest shorthand is for referencing one of your own repositories,which you can do by simply entering its name. For example if you're@citycide, entering fugitive open cascade would openyour browser to cascade.

<owner>/<name>

You can also use any <owner>/<project> combination you'd like, such as:

• fugitive open nim-lang/nim
• fugitive mirror soasme/nim-markdown

By default fugitive will use your local git username (fromgit config --global user.name) for these shorthands but you can explicitlyset it yourself. You'll also be prompted to provide it if you try to usethese shorthands and fugitive isn't able to infer it.

alias installation

After installation, you can make some of fugitive's commands more accessible byrunning fugitive install, which will attach them to git as subcommands,making git undo == fugitive undo.

Commands installed to git include:

alias
changelog
lock
mirror
open
profile
release
scrap
summary
undo
unlock
unstage

Existing aliases are safe as fugitive will not override them unlessthe --override ( or -o ) flag is explicitly passed.

If you want to remove these installed aliases, use fugitive uninstall.Only aliases that fugitive installed and match the fugitive command willbe removed.

Note the mirror command - git commands can't be overridden, so whilefugitive clone is possible it can't be aliased as a git subcommand.Therefore fugitive mirror is the main command and the one that willbe attached to git, while clone is just an alias for convenience.

building

To build fugitive from source you'll need to install Nim and its packagemanager Nimble.

1. Clone the repo: git clone https://github.com/citycide/fugitive.git
2. Move into the newly cloned directory: cd fugitive
3. Compile a development build for your current platform: nimble build
4. Compile a release build for your current platform: nimble release

contributing

This project is open to contributions of all kinds! Please check and searchthe issues if you encounter a problem before opening a new one.Pull requests for improvements are also welcome — see thesteps above for development.

license

MIT © Bo Lingen / citycide