aboutsummaryrefslogtreecommitdiffstats
path: root/doc/git-sugpatch.1.txt
blob: 8d31bba5d4e4135917f9b7d5a0916ff0a491affd (plain)
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
git-sugpatch(1)
===============

NAME
----
git-sugpatch - Show diffs for GitHub suggestions

SYNOPSIS
--------
'git sugpatch' [options] <suggestion>...

DESCRIPTION
-----------
Show the diffs of the given GitHub suggestion references.

A suggestion reference is either a URL to the comment, or its ID.

OPTIONS
-------
--github-token::
	A GitHub API token with the “repo” permission. This can also be set
	with `githubSuggestion.githubToken` or the `GITHUB_TOKEN`
	environment variable.

-h, --help::
	Print usage help.

--remote::
	The remote to use to fetch the suggestion from when passing a
	suggestion ID. This can also be set with `githubSuggestion.remote`.
	Defaults to `origin`.

-V, --version::
	Print the program version.

CONFIGURATION
-------------
Configuration options can be specified either as command line options,
or in the Git config. Command line options take precedence.

githubSuggestion.githubToken::
	A GitHub API token with the “repo” permission. This will override
	the `GITHUB_TOKEN` environment variable.

githubSuggestion.remote::
	The remote to use to fetch the suggestion from when passing a
	suggestion ID. Defaults to `origin`.

ENVIRONMENT VARIABLES
---------------------
GITHUB_TOKEN::
	A GitHub API token with the “repo” permission.

EXAMPLES
--------
Suggestion references can be specified either as URLs:

	$ git sugpatch https://github.com/teddywing/github-suggestion/pull/1#discussion_r459691747

or as comment IDs:

	$ git sugpatch 459691747

They can also be mixed:

	$ git sugpatch 459692838 https://github.com/teddywing/github-suggestion/pull/1#discussion_r459691747

SEE ALSO
--------
git-sugapply(1)