JavaScript
Clone or download
Latest commit dbe537f Apr 2, 2017

README.md

🎏 git-labelmaker travis-build-badge Coverage Status Join the chat at https://gitter.im/himynameisdave/git-labelmaker

Edit GitHub labels from the command line using git-labelmaker! You can easily add or remove GitHub labels, making it easier for your projects to adhere to a sane labelling scheme.

Install

Install git-labelmaker globally:

yarn global add git-labelmaker

OR

npm i -g git-labelmaker

Currently you must be using version >= 4.0.0 of node, because we're using some fancy-shmancy ES6 stuff (Promises are too awesome to not use), and also because the dependant package git-label also currently requires >= 4.0.0.

Use npm version >= 3.9.0,

Usage

Using this bad boy is a breeze. First cd into your git repository, run the command and follow the prompts!

git-labelmaker

Preview of git-labelmaker

Token

To interact with the GitHub API, you will need your own access token, which you can generate over here. Make sure your token has repo permissions.

Instead of having to enter your token each time, git-labelmaker will remember it and keep it secure for you while you instead only need to remember a password you create. You can make your password whatever you like - passwords are easier to remember than tokens!

Currently, git-labelmaker only supports calling the public GitHub API. If you are using GitHub Enterprise and have a custom API path, you might want to check out git-label instead.

Add Custom Labels

You can add your own labels one at a time. You will be prompted for your new label's text and color. Include the # in front of your 3 or 6 digit hex color. Add as many as you like!

Add Labels From Package

If you have a labels package in your current directory that you would like to use for adding labels, just supply the path and name of that file. So like if it's at the root of the current directory, just labels.json.

It must be a valid, parsable JSON file (although the extension doesn't matter). Check out these really good ones if you need a template.

Create Package From Labels

Create a git label package from the current labels on a repo, so that you can easily use it again.

Remove Labels

You can also remove labels. Just select the ones you want to ditch and 💥 they're gone.

Contributing

Feel free to contribute to the project by opening a Pull Request, filing a new issue, or by barking at me on the twitters.

Related Stuff:

  • git-label by jasonbellamy, which git-labelmaker uses to add and remove labels
  • git-label-packages is a really good set of default packages if you really want to level up your projects
  • git-label-faces is a joke package set that you should totally never use for real
  • Sane GitHub Labels - an article I wrote about the importance of a good, rational labelling system in your projects

Created by Dave Lunny in the glorious year of 2017. Licensed under MIT