An open API service indexing awesome lists of open source software.

https://github.com/seegno/github-labels

A manager for GitHub issue labels
https://github.com/seegno/github-labels

ghlabels github github-labels issue-labels issues labels manager

Last synced: 9 days ago
JSON representation

A manager for GitHub issue labels

Awesome Lists containing this project

README

          

# GitHub Labels

[![npm](https://img.shields.io/npm/v/ghlabels.svg?style=flat-square)](https://npmjs.org/package/ghlabels)
![node](https://img.shields.io/node/v/ghlabels.svg?style=flat-square)
[![Build Status](https://img.shields.io/travis/seegno/github-labels/master.svg?style=flat-square)](https://travis-ci.org/seegno/github-labels)
[![Coverage Status](https://img.shields.io/coveralls/seegno/github-labels/master.svg?style=flat-square)](https://coveralls.io/github/seegno/github-labels?branch=master)

A command line tool that helps you manage your GitHub repository issue labels.

## Installation

Using npm:

```sh
npm install --global ghlabels
```

Or Yarn:

```sh
yarn global add ghlabels
```

## Usage

### Basic usage

You can provide options as arguments or leave then blank and they will be prompted.

```sh
ghlabels --repository foo/bar --token foobar --file ./path/somefile
```

Note: As an alternative you can provide options as enviroment variables (e.g. GITHUB_LABELS_TOKEN).

### Copy from another repo

```sh
ghlabels copy --source seegno/github-labels --target foo/bar --token foobar
```

### List

```sh
ghlabels list --repository seegno/github-labels
```

### Client

You can also import ghlabels client and use it as a module:

```js
import { copyLabelsFromRepo, listLabels, updateLabels } from 'ghlabels';

// Example of copying labels from a source repo.
copyLabelsFromRepo({
source: 'seegno/github-labels'
target: 'foo/bar',
token: 'foobar'
});

// Example of listing all labels from a repo.
listLabels({
repository: 'seegno/github-labels',
token: 'foobar'
});

// Example of updating all labels from a repo.
updateLabels({
repository: 'foo/bar',
token: 'foobar'
});
```

## Contributing & Development

### Contributing

Found a bug or want to suggest something? Take a look first on the current and closed [issues](https://github.com/seegno/github-labels/issues). If it is something new, please [submit an issue](https://github.com/seegno/github-labels/issues/new).

### Develop

It will be awesome if you can help us evolve `github-labels`. Want to help?

1. [Fork it](https://github.com/seegno/github-labels).
2. `npm install`.
3. Hack away.
4. Run the tests: `npm test`.
5. Create a [Pull Request](https://github.com/seegno/github-labels/compare).

### Release

```sh
npm version [ | major | minor | patch] -m "Release %s"
```

## License

MIT