Skip to content

Commit 120d607

Browse files
committed
Improve top-level help with usage examples
1 parent f63c5b4 commit 120d607

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

bin/gh-app.js

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,19 @@ const commands = {
1313
const help = `Usage: gh-app <command> [options]
1414
1515
Commands:
16-
token Generate an installation token
17-
pull Pull a repo using a fresh token
18-
clone Clone a repo using a fresh token
19-
check-token Show token validity and expiry
20-
list-repos List accessible repositories
16+
token Generate an installation token
17+
pull <owner/repo> [branch] Pull a repo using a fresh token
18+
clone <owner/repo> [directory] Clone a repo using a fresh token
19+
check-token Show token validity and expiry
20+
list-repos List accessible repositories
21+
22+
Examples:
23+
gh-app token
24+
export GITHUB_TOKEN=$(gh-app token 2>/dev/null)
25+
gh-app pull myorg/myrepo main
26+
gh-app clone myorg/myrepo ./local-dir
27+
gh-app check-token
28+
gh-app list-repos
2129
2230
Options:
2331
-h, --help Show this help message

0 commit comments

Comments
 (0)