Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shresht7/gh-gitignore
A GitHub CLI extension to generate .gitignore files 📄
https://github.com/shresht7/gh-gitignore
cli gh-extension gitignore
Last synced: 22 days ago
JSON representation
A GitHub CLI extension to generate .gitignore files 📄
- Host: GitHub
- URL: https://github.com/shresht7/gh-gitignore
- Owner: Shresht7
- License: mit
- Created: 2023-01-22T10:53:27.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-13T08:47:30.000Z (9 months ago)
- Last Synced: 2024-06-21T18:53:46.492Z (5 months ago)
- Topics: cli, gh-extension, gitignore
- Language: Go
- Homepage:
- Size: 54.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `gh-gitignore`
A GitHub CLI extension to generate `.gitignore` files.
The `.gitignore` templates are obtained from the GitHub API (https://docs.github.com/en/rest/gitignore).
---
## 📦 Installation
### Requirements
- [GitHub CLI](https://cli.github.com/)
### Install
```sh
gh extension install Shresht7/gh-gitignore
```
---
## 💻 Usage
Invoke the cli extension like so:
```sh
gh gitignore
```
To create a gitignore file:
```sh
gh gitignore create Node
```
[⬆️ Back to top][top]
## ⌨️ Commands
### `create`
Create a gitignore file
#### Alias
`new`, `add`, `init`, `clone`
#### Usage
```sh
gh-gitignore create [flags]
```
#### Flags
| Flag | Type | Description | Default |
| ----------------- | -------- | --------------------------------- | ---------- |
| `--dest, -d` | `string` | Destination of the gitignore file | .gitignore |
| `--overwrite, -o` | `bool` | Overwrite the gitignore file | false |
#### Examples
```sh
gh gitignore create Go
gh gitignore init Go Python
gh gitignore create Go Python -d .gitignore
```
[⬆️ Back to top][top]
### `list`
Lists all gitignore templates
#### Usage
```sh
gh-gitignore list
```
#### Examples
```sh
gh gitignore list
```
[⬆️ Back to top][top]
### `view`
View a gitignore file
#### Alias
`show`, `get`
#### Usage
```sh
gh-gitignore view
```
#### Examples
```sh
gh gitignore view Go
gh gitignore view Go Python
```
[⬆️ Back to top][top]
---
## 📜 License
This software is licensed under the [MIT License](). See the [LICENSE](./LICENSE) file for details.
[top]: #gh-gitignore