https://github.com/ivansantiagojr/zignr
Generate .gitgnore files from command line with zignr
https://github.com/ivansantiagojr/zignr
cli git-ignore zig
Last synced: 4 months ago
JSON representation
Generate .gitgnore files from command line with zignr
- Host: GitHub
- URL: https://github.com/ivansantiagojr/zignr
- Owner: ivansantiagojr
- Created: 2024-02-07T04:24:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-26T14:07:25.000Z (4 months ago)
- Last Synced: 2025-02-26T15:22:49.765Z (4 months ago)
- Topics: cli, git-ignore, zig
- Language: Zig
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# zignr
This is a CLI tool to generate `.gitgnore` files written in zig.
# Installation
For now, you can install from our pre-built binary (Linux only):
```sh
curl -sSL https://raw.githubusercontent.com/ivansantiagojr/zignr/main/install.sh | bash -
```
> To make `zignr` available globally you should have `~/.local/bin` on you `PATH`
# Usage
To create a .gitgnore file you can simply use `zignr > .gitnore`. This command will overwrite your .gitignore file. Example:
```bash
zignr zig > .gitgnore
```
Multi language example:
```bash
zignr zig,python,lua > .gitgnore
```
To see the list of all .gitignore templates you can call `zignr` with, just use:
```bash
zignr list
```
# References
This project started as a Zig learning experience (and still is), so I will link my references below:
First of all, zignr is heavily inspired by [ignr.py](https://github.com/Antrikshy/ignr.py), which uses the [gitignore.io](https://www.toptal.com/developers/gitignore) API.
Zig references I used:
- [Zig Cookbook](https://zigcc.github.io/zig-cookbook/)
- [Zig documentation](https://ziglang.org/documentation/master/)
- [Zig Common Tasks](https://renatoathaydes.github.io/zig-common-tasks/)
- [Ziglings](https://codeberg.org/ziglings)
- [Zig Guides](https://github.com/tr1ckydev/zig_guides)
- [Introduction to Zig](https://pedropark99.github.io/zig-book/)