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

https://github.com/gozeloglu/lgtm

:package: LGTM fancy text.
https://github.com/gozeloglu/lgtm

bash bash-script cli lgtm shell

Last synced: about 2 months ago
JSON representation

:package: LGTM fancy text.

Awesome Lists containing this project

README

          

# lgtm

lgtm is a simple tool for helping LGTM fancy text message to clipboard via command line. LGTM is an abbreviation for
**Looks Good To Me**. Generally, it is used during code reviews when the pull request is ready to merge on main branch.
Its usage is so simple.

## Installation

You can install lgtm in 2 different way.

### Manual Installation

You can use `setup` script to make script ready for your environment.

```shell
chmod +x setup
./setup
```

It creates a symbolic link like a shortcut in Windows. Be aware of the location of the creating symbolic link. On my
machine, I prefer to locate on `/usr/local/bin`. If it does not work for your machine, you can change with
another `$PATH` directory.

### Homebrew - macOS

If you use [Homebrew](https://brew.sh/) you can install like this:

````shell
brew install lgtm
````

This command will install and make ready to use for you.

## Run

Now, it is ready to run this command from anywhere. To make sure that it is working on other directories, you can change
your directory and run the following command.

```shell
$ lgtm
```

Finally, you can use this command anytime that you need. It basically copies the LGTM fancy test to your clipboard.

## Usage

lgtm usage is simple.

````shell
A simple command-line tool for copying LGTM fancy text to your clipboard.

Usage: lgtm [option]

OPTIONS:
-h, --help Print this usage information
-v, --version Print the lgtm version

For bug reporting, feature requests, and contributions, please see:
https://github.com/gozeloglu/lgtm
````

## Sample

![lgtm demo](demo/lgtm-demo.gif)

## LICENSE

[MIT](https://github.com/gozeloglu/lgtm/blob/main/LICENSE)