https://github.com/taylorthurlow/thicket

a better one-line git log
https://github.com/taylorthurlow/thicket

Last synced: about 2 months ago
JSON representation

a better one-line git log

• Host: GitHub
• URL: https://github.com/taylorthurlow/thicket
• Owner: taylorthurlow
• License: mit
• Created: 2019-06-06T16:41:26.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-12T16:24:55.000Z (over 1 year ago)
• Last Synced: 2023-08-04T06:44:52.315Z (over 1 year ago)
• Language: Crystal
• Size: 274 KB
• Stars: 6
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GitHub release](https://img.shields.io/github/release/taylorthurlow/thicket.svg)](https://github.com/taylorthurlow/thicket/releases)

![Specs](https://github.com/taylorthurlow/thicket/workflows/specs/badge.svg)

![Build](https://github.com/taylorthurlow/thicket/workflows/publish/badge.svg)



    



`thicket` is a wrapper for `git log` which aims to make its output just a little more clean.

## Installing

Currently you must either download the binary provided in the most recent release, or clone the repository and build it from source. The next goal is to set up distribution through Homebrew.

### From a Released Binary

- Navigate to the [releases page](https://github.com/taylorthurlow/thicket/releases) and find the release you want to install.

- Download the binary associated with the release

- Move the binary downloaded into a directory which is included in your `$PATH`.

### Build from Source

- Make sure you have `crystal` installed.

- Clone the repository and run `crystal build src/thicket.cr --release`.

- Copy the generated binary which is located in the root of the project to a directory which is included in your $PATH.

## Usage

For help, run `thicket -h`:

```plain

$ thicket -h

Usage: thicket [options]

    -v, --version                    Print the version number

    -d, --directory=DIRECTORY        Path to the project directory

    -n, --commit-limit=LIMIT         Number of commits to parse before stopping

    -a, --all                        Displays all branches on all remotes

    -r, --refs                       Consolidate the refs list

    --main-remote=MAIN_REMOTE        The name of the primary remote, defaults to 'origin'

    -p, --color-prefixes             Adds coloring to commit message prefixes

    --git-binary=BINARY              Path to a git executable

```

## Contributing

Please open an issue regarding any changes you wish to make before starting to work on anything. I am always open to providing assistance, so if you need to ask any questions please don't hesitate to do so, whether it be how to approach solving a problem or questions regarding how I might prefer something be implemented.

### Building

```bash

shards install

crystal build --release src/thicket.cr -o bin/thicket

```