https://github.com/jasonuc/gignr
Effortlessly Manage and Generate .gitignore files
https://github.com/jasonuc/gignr
bubbletea cli cobra gitignore go golang utility viper
Last synced: 6 months ago
JSON representation
Effortlessly Manage and Generate .gitignore files
- Host: GitHub
- URL: https://github.com/jasonuc/gignr
- Owner: jasonuc
- License: mit
- Created: 2025-01-22T22:58:29.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-14T01:55:56.000Z (6 months ago)
- Last Synced: 2025-04-14T02:48:00.415Z (6 months ago)
- Topics: bubbletea, cli, cobra, gitignore, go, golang, utility, viper
- Language: Go
- Homepage:
- Size: 127 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gignr
`gignr` is a powerful **CLI tool** designed to help developers fetch, manage, and create `.gitignore` templates with ease. It integrates templates from **GitHub**, **TopTal**, and user-defined repositories.
## ✨ Features
- 📦 **Fetch `.gitignore` templates** from:
- `GitHub`
- `GitHub Global`
- `GitHub Community`
- `TopTal`
- Custom **user-defined repositories**
- 🔍 **TUI-powered template search** with filtering and selection.
- ⚡ **Merge multiple templates** into a single `.gitignore` file.
- 💾 **Save and manage `.gitignore` templates locally**.
- 🛠️ **Highly configurable** via `config.yaml`.
## 📥 Installation
- Using Go 🐹
```sh
go install github.com/jasonuc/gignr@latest
```
- Using Homebrew 🍺
```sh
brew tap jasonuc/tap && brew install gignr
```
## 📌 Usage
### 🛠️ **Creating a `.gitignore` File**
```sh
gignr create gh:Go tt:clion best_go_gitignore
```
- `gh:` → Fetch from **GitHub**
- `ghg:` → Fetch from **GitHub Global**
- `ghc:` → Fetch from **GitHub Community**
- `tt:` → Fetch from **TopTal**
- *(No prefix)* → Fetch from **locally saved templates**
### 🎯 **Adding a Custom Repository**
```sh
gignr add https://github.com/jasonuc/gitignore-templates -n jc
```
- `-n myrepo` sets a **nickname** for the repository.
### 🔍 **Searching for Templates (TUI)**
```sh
gignr search
```
- **Navigate sources**: `←/→`, `tab`
- **Select template**: `Enter`
- **Filter templates**: Start typing
- **Copy command to generate selection**: `Shift + C`
- **Exit**: `Ctrl + C`
### 💾 **Saving a Custom `.gitignore`**
```sh
gignr save best_go_gitignore
```
- Saves `.gitignore` from the **current directory** to **local storage**.
- Storage path is configurable in `config.yaml`.
## ⚙️ Configuration (`config.yaml`)
Located at: `~/.config/gignr/config.yaml`
```yaml
templates:
storage_path: "~/.config/gignr/templates"
repositories:
jc: "https://github.com/jasonuc/gitignore-templates"
```
## 🤝 Contributing
Contributions are welcome!
Fork the repo, make your changes, and open a **Pull Request** 🚀
## 📜 License
This project is licensed under the **MIT License**.