Examples
Table of Contents
- Adding a Tool
- Listing Tracked Tools
- Checking for Updates
- Upgrading All Tools
- Using JSON Output for Scripting
- Removing a Tool
- Enabling GitHub Authentication
Adding a Tool
Register a Go-installed binary so gogitup can track it:
gogitup add ghorgsync
Install and register a tool directly from a full Go command package path:
gogitup install golang.org/x/vuln/cmd/govulncheck
Listing Tracked Tools
View all registered binaries and their installed versions:
gogitup list
Registered Binaries
Name Module Path Installed Version
────────── ────────────────────────────────────── ─────────────────
bulkfilepr github.com/UnitVectorY-Labs/bulkfilepr v0.2.2
ghorgsync github.com/UnitVectorY-Labs/ghorgsync v0.1.0
Checking for Updates
See which tools have newer versions available:
gogitup check
Update Check
Name Installed Latest Update
────────── ───────── ────── ──────
bulkfilepr v0.2.2 v0.2.3 yes
ghorgsync v0.1.0 v0.1.0 no
The check command only checks for updates once every 24 hours, caching the latest version information. Use gogitup check --force to bypass the cache and fetch it again.
Upgrading All Tools
Run a single command to upgrade every tracked binary that has a newer release:
gogitup upgrade
gogitup upgrade --verbose
⟳ Upgrading 'bulkfilepr' from v0.2.2 to v0.2.3...
✓ Upgraded 'bulkfilepr' to v0.2.3
ℹ 'ghorgsync' is already up to date (v0.1.0)
✓ Upgraded 1 binary(ies).
Using JSON Output for Scripting
Both list and check support --json for machine-readable output:
gogitup check --json
[
{
"name": "bulkfilepr",
"installed_version": "v0.2.2",
"latest_version": "v0.2.3",
"update_available": true
},
{
"name": "ghorgsync",
"installed_version": "v0.1.0",
"latest_version": "v0.1.0",
"update_available": false
}
]
Removing a Tool
Stop tracking a binary without uninstalling it:
gogitup remove ghorgsync
Enabling GitHub Authentication
Edit ~/.gogitup and set github_auth to true to use authenticated API requests and avoid rate limits:
apps:
- name: ghorgsync
- name: bulkfilepr
github_auth: true
Then ensure a token is available via the GITHUB_TOKEN environment variable or the GitHub CLI (gh auth token).