hubugs

Simple client for GitHub issues

SYNOPSIS

hubugs [option]… <command>

DESCRIPTION

hubugs is a very simple client for working with GitHub’s issue tracker. It allows you to perform all the issue related tasks you’d normally perform from the command line.

OPTIONS

--version

show program’s version number and exit

-h, --help

show program’s help message and exit

--pager <pager>

pass output through a pager

--no-pager

do not pass output through pager

-p <project>, --project=<project>

GitHub project to operate on. You can supply just <project> if you wish to work on one of your own projects, or <user>/<project> to operate on another user’s repository. Default is derived from the hubugs.project setting in the git config or the current repository, if possible.

-u <url>, --host-url=<url>

host to connect to, for GitHub Enterprise support

COMMANDS

setup

Generate a new GitHub access token

--local

set access token for local repository only

list

List bugs for a project

-s <state>, --state=<state>

state of bugs to operate on

-l <label>, --label=<label>

list bugs with specified label

-o <order>, --order=<order>

sort order for listing bugs

-p <number>, --page <number>

page number

-r, --pull-requests

list only pull requests

show

Show specific bug(s) from a project

-f, --full

show bug including comments

-p, --patch

display patches for pull requests

-o, --patch-only

display only the patch content of pull requests

-b, --browse

open bug in web browser

open

Open a new bug in a project

-a label, --add label

add label to issue

--stdin

read message from standard input

comment

Comment on an existing bug in a project

--stdin

read message from standard input

-m <text>, --message=<text>

comment text

edit

Edit an existing bug in a project

--stdin

read message from standard input

close

Close an existing bug in a project

--stdin

read message from standard input

-m <text>, --message=<text>

comment text

reopen

Reopen a previously closed bug in a project

--stdin

read message from standard input

-m <text>, --message=<text>

comment text

label

Perform labelling actions on an existing bug in a project

-a <label>, --add=<label>

add label to issue

-r <label>, --remove=<label>

remove label from issue

milestone

Add an issue to a milestone

milestones

Manage repository milestones

-o <order>, --order=<order>

sort order for listing bugs

-s <state>, --state=<state>

state of bugs to operate on

-c <name>, --create=<name>

create new milestone

-l, --list

list available milestones

CONFIGURATION

You can specify the template set to use by defining a hubugs.templates setting in your git configuration files. For example:

▶ git config --global hubugs.templates my_templates

You can also set project specific template sets by editing a repository’s config. See git-config(1).

You can set a default value for the --pager and --host-url options by defining hubugs.pager or hubugs.host-url respectively in your git configuration files.

BUGS

None known.

AUTHOR

Written by James Rowe

RESOURCES

Home page, containing full documentation: http://hubugs.readthedocs.io/

Issue tracker: https://github.com/JNRowe/hubugs/issues/

COPYING

Copyright © 2010-2016 James Rowe.

hubugs is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

hubugs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with hubugs. If not, see <http://www.gnu.org/licenses/>.