A CLI for generating URLs to pre-filled GitHub issue forms
JavaScript Shell
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
README.md
example.sh
index.js
package-lock.json
package.json

README.md

github-issue-template

A CLI for generating URLs to pre-filled GitHub issue forms

GitHub has a little-known feature that allows you to pass query params to the /issues/new page. Those query params can specify values to inject into the issue form's title and body inputs.

Installation

npm i -g github-issue-template

Usage

The CLI expects three arguments:

  • repo
  • title
  • body
github-issue-template --repo sally/project --title "new thing" --body "the body"

If you want to use a file on disk as the body, cat comes to the rescue:

github-issue-template --repo sally/project --title "new thing" --body "$(cat some/file.md)"

Dependencies

  • is-url: Check whether a string is a URL.
  • open: open a file or url in the user's preferred application
  • yargs: Light-weight option parsing with an argv hash. No optstrings attached.

License

MIT

Generated by package-json-to-readme