UNPKG

issue

Version:

Command line tool for displaying issues using the issuemd library

github.com/issuemd/issue

issuemd/issue

98 lines (51 loc) • 2.64 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# issue Command line tool for displaying issues using the [issuemd library](https://github.com/issuemd/issuemd). **GitHub** plugin is included. **issue** can be extended with plugins for different issue tracking systems. ## Installation $ npm install -g issue ## Usage (GitHub plugin) ### List issues from local GitHub repo `cd` into local GitHub repo and run the `list` command... $ cd bootstrap $ issue github list ### List issues from online GitHub repo Specify the target project with the `--repo` flag $ issue github list --repo twbs/bootstrap ### Show individual issue To show individual issue, add the issue number as the last argument... $ issue github show --repo twbs/bootstrap <issue-number> ... or from within github project ... $ issue github show <issue-number> ### Show filtered list of issues The `list` command supports standard GitHub filters: `'filter', 'state', 'labels', 'sort', 'direction', 'since'` $ issue github list --state open ### Locate repositories $ issue github locate <search-term> Locate command can be used to find any repositories on GitHub. Standard GitHub filters are supported: `'in', 'size', 'forks', 'fork', 'created', 'pushed', 'user', 'repo', 'language', 'stars'` For example, to find all repositories containing `bootstrap` keyword written in assembly. $ issue github locate bootstrap --language assembly ### Limit check If you are not logged in, GitHub limits you to 60 core requests per half hour, but if logged in, you get 5000. $ issue github limit Output: core requests: 27/60, resets in: 24 mins search requests: 10/10, resets in: 2 mins ### GitHub login $ issue github login To increase the request limit, and get access to your own private repositories you should login with your GitHub credentials. GitHub login creates a **_personal access token_** for issuemd on your GitHub account. **_Personal access tokens_** are named: $ issuemd/issue-<username>@<computer-name> This enables you to login and use **issue** from multilple locations at the same time. GitHub logout command clears out credentials from your `.issuerc` configuration file. $ issue github logout ### Personal issues Once you are logged in, you can list all your assigned issues in all projects. $ issue github list mine ## Configuration Change directory to where you want to store your configuration, and run init command... ``` $ issue init ``` This will create `.issuerc` configuration file in your current directory - typically your home folder, or in a project folder to create overrides.