ghkit

ghkit is a CLI tool for installing GitHub repository templates such as issue templates, pull request templates, and meta files like CODEOWNERS and CONTRIBUTING.md.

📦 Installation

You can install ghkit via go install or Homebrew.

With Go

go install github.com/optiflowic/ghkit@latest

With Homebrew

brew install optiflowic/tap/ghkit

🚀 Usage

Add all templates:

ghkit add all --path ./your-repo

Add a specific issue template (e.g., bug):

ghkit add issue bug --path ./your-repo

Add a pull request template:

ghkit add pr --path ./your-repo

Add meta templates like CODEOWNERS, CONTRIBUTING.md, etc.:

ghkit add meta codeowners --path ./your-repo

🧾 Available Issue Templates

• bug
• feature
• question
• task
• docs
• feedback
• config

🛠️ Options

Most subcommands support the following flags:

• --format, -f: Format of the issue template. Options: yml, md. Default: yml
• --lang, -l: Language for the templates. Options: en, ja. Default: en
• --path: Root path of your repository (e.g., ./your-repo). Default: .
• --force: Overwrite existing files.
• --verbose: Outputs log information.
• --debug: Outputs debug logs.

💡 Examples

Add a Japanese markdown template for feature requests:

ghkit add issue feature --format md --lang ja --path ./your-repo

Add all templates to a repository root and overwrite if needed:

ghkit add all --format yml --lang en --path ./your-repo --force

📁 Output Structure

Files are generated under .github/ in the specified repository path:

your-repo/
└── .github/
    ├── ISSUE_TEMPLATE/
    │   ├── bug.yml
    │   ├── feature.yml
    │   └── ...
    ├── PULL_REQUEST_TEMPLATE.md
    ├── CODEOWNERS
    ├── CONTRIBUTING.md
    └── ...

⚖️ License

This project is licensed under the MIT License.