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

https://github.com/bakayu/lq

A CLI tool to add .gitignore and LICENSE to your projects right from your terminal
https://github.com/bakayu/lq

bubbletea cli gitignore-generator go license-generator

Last synced: 5 months ago
JSON representation

A CLI tool to add .gitignore and LICENSE to your projects right from your terminal

Awesome Lists containing this project

README

          

# lq
A CLI tool to add .gitignore and LICENSE to your projects right from your terminal

[![CI](https://github.com/bakayu/lq/actions/workflows/CI.yml/badge.svg)](https://github.com/bakayu/lq/actions/workflows/CI.yml)
[![Release](https://github.com/bakayu/lq/actions/workflows/release.yml/badge.svg)](https://github.com/bakayu/lq/actions/workflows/release.yml)
[![License](https://img.shields.io/github/license/bakayu/lq)](./LICENSE)
[![Latest](https://img.shields.io/github/v/release/bakayu/lq?sort=semver)](https://github.com/bakayu/lq/releases/latest)
![Go](https://img.shields.io/badge/Go-1.25-00ADD8?logo=go&logoColor=white)

## Motivation
I wanted a simple CLI tool to generate `.gitignore` and `LICENSE` templates. I regularly forget to add these files and don’t want to do it manually. GitHub CLI (`gh repo new`) already asks about these, but its a command to init new repos, what about already initialized git repos? For this I built a focused tool just for `.gitignore` and `LICENSE` generation.

**Tech choice:** Go + Bubble Tea is the best fit here: minimal, clean, and fast for a TUI.

## Installation

**Install Script**

```bash
curl -sSL https://raw.githubusercontent.com/bakayu/lq/master/install.sh | bash
```

**Go install**

```bash
go install github.com/bakayu/lq/cmd/lq@latest
```

**From Releases**

- Download the latest binary from: https://github.com/bakayu/lq/releases/latest

## Usage

After installation just type in your terminal:

```sh
lq
```

[![asciicast](https://asciinema.org/a/780438.svg)](https://asciinema.org/a/780438)

Screenshots

Invoking the CLI

![ss1](./docs/assets/images/ss1.png)

Generating `.gitignore` templates

![ss2](./docs/assets/images/ss2.png)

Generating `LICENSE` templates

![ss3](./docs/assets/images/ss3.png)

## License
[MIT LICENSE](./LICENSE)