GitHub/GH Client - Revision history

Kenneth: /* Clone Repo */

2026-03-16T08:31:03Z

Clone Repo

← Older revision		Revision as of 08:31, 16 March 2026
Line 24:		Line 24:

	https:		https:
	~~git~~ repo clone [ORG_or_OWNER]/[REPO]		gh repo clone [ORG_or_OWNER]/[REPO]

	ssh:		ssh:
	~~git~~ repo clone git@github.com:[ORG_or_OWNER]/[REPO]		gh repo clone git@github.com:[ORG_or_OWNER]/[REPO]

	Set protocol to be ssh:		Set protocol to be ssh:
	gh config set git_protocol ssh		gh config set git_protocol ssh

			== Repo Update ==

			: "Sync destination repository from source repository. Syncing uses the default branch of the source repository to update the matching branch on the destination repository so they are equal. A fast forward update will be used except when the `--force` flag is specified, then the two branches will be synced using a hard reset."

			# Sync local repository from remote parent
			$ gh repo sync

			# Sync local repository from remote parent on specific branch
			$ gh repo sync --branch v1

			--force Hard reset the branch of the destination repository to match the source repository

	== Auth ==		== Auth ==

2026-03-16T08:24:03Z

GH_TOKEN

← Older revision		Revision as of 08:24, 16 March 2026
Line 91:		Line 91:

	See [[make-jwt.py]]		See [[make-jwt.py]]

			----------

			Linux:
			printf <YOUR_TOKEN> \| gh auth login --with-token

			export PAT="<YOUR_TOKEN>"
			printf "%s" "$PAT" \| gh auth login --with-token

			Windows Powershell:
			$PAT="<YOUR_TOKEN>"
			$PAT \| gh auth login --with-token

			Windows CMD:
			set PAT=<YOUR_TOKEN>
			echo %PAT% \| gh auth login --with-token

			----------

			GH_TOKEN:
			* Run gh commands: Once the environment variable is set, the gh client will automatically use this token for authentication without needing to run gh auth login

			Linux:
			export GH_TOKEN="<YOUR_TOKEN>"

			Windows Powershell:
			$env:GH_TOKEN="<YOUR_TOKEN>"

			Windows CMD:
			set GH_TOKEN="<YOUR_TOKEN>"

	== api ==		== api ==

2026-02-21T07:45:46Z

Clone Repo

← Older revision		Revision as of 07:45, 21 February 2026
Line 23:		Line 23:
	== Clone Repo ==		== Clone Repo ==

	git repo clone [~~ORG~~]/[REPO]		https:
			git repo clone [ORG_or_OWNER]/[REPO]

			ssh:
			git repo clone git@github.com:[ORG_or_OWNER]/[REPO]

			Set protocol to be ssh:
			gh config set git_protocol ssh

	== Auth ==		== Auth ==

2026-02-21T07:41:56Z

Doc

← Older revision		Revision as of 07:41, 21 February 2026
Line 20:		Line 20:

	https://cli.github.com/manual/gh_api		https://cli.github.com/manual/gh_api

			== Clone Repo ==

			git repo clone [ORG]/[REPO]

	== Auth ==		== Auth ==

2026-02-21T07:35:01Z

Installation

← Older revision		Revision as of 07:35, 21 February 2026
Line 10:		Line 10:
	Really really old version:		Really really old version:
	pip3 install gh		pip3 install gh

			=== winget ===

			See [[WinGet#GitHub Client]]

			winget install --id GitHub.cli --source winget

	== Doc ==		== Doc ==

2025-01-21T16:37:25Z

List

← Older revision		Revision as of 16:37, 21 January 2025
Line 87:		Line 87:
	=== List ===		=== List ===

	gh api /orgs/ORG/actions/runners		page 1 (pagination)
			gh api /orgs/ORG/actions/runners

			=== Installation Key ===

			...

	== keywords ==		== keywords ==

2024-08-15T05:00:27Z

api

← Older revision		Revision as of 05:00, 15 August 2024
Line 78:		Line 78:

	gh api		gh api

			ref: https://cli.github.com/manual/gh_api

	== Action Runners ==		== Action Runners ==

2024-08-12T21:00:58Z

@@ Line 15: / Line 15: @@
   https://cli.github.com/manual/gh_api
-== Login ==
+== Auth ==
   gh auth status
 <pre>
 $ gh auth status
@@ Line 27: / Line 28: @@
    - To re-authenticate, run: gh auth login -h github.com
    - To forget about this account, run: gh auth logout -h github.com -u YOUR-USER
 </pre>
@@ Line 41: / Line 74: @@
 See [[make-jwt.py]]
 == api ==

2024-08-12T20:04:24Z

@@ Line 1: / Line 1: @@
 == Doc ==
@@ Line 4: / Line 16: @@
 == Login ==
 === GH_TOKEN ===
@@ Line 30: / Line 54: @@
 gh api /orgs/ORG/actions/runners

2023-12-01T20:43:47Z

← Older revision		Revision as of 20:43, 1 December 2023
Line 1:		Line 1:
			== Doc ==

			https://cli.github.com/manual/gh_api

			== Login ==

			=== GH_TOKEN ===

			<pre>
			PRIVATE_KEY='private_key.pem'
			APP_ID='12345'
			INSTALLATION_ID='54321'

			JWT=`./make-jwt.py $PRIVATE_KEY $APP_ID`
			GH_TOKEN=`curl -s --request POST --url "https://api.github.com/app/installations/$INSTALLATION_ID/access_tokens" --header "Accept: application/vnd.github+json" --header "Authorization: Bearer $JWT" --header "X-GitHub-Api-Version: 2022-11-28" \| python -c "import sys, json; print(json.load(sys.stdin)['token'])"`
			echo "export GH_TOKEN=$GH_TOKEN"

			See [[make-jwt.py]]


			== api ==

	gh api		gh api

			== Action Runners ==

			https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28

			=== List ===

			gh api /orgs/ORG/actions/runners