https://github.com/nao1215/gup

gup - Update binaries installed by "go install" with goroutines.
https://github.com/nao1215/gup

cli-app command-line-tool cross-platform go golang golang-tools update updater user-friendly

Last synced: 14 days ago
JSON representation

gup - Update binaries installed by "go install" with goroutines.

Host: GitHub
URL: https://github.com/nao1215/gup
Owner: nao1215
License: apache-2.0
Created: 2022-02-19T06:31:07.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2025-04-24T12:06:26.000Z (11 months ago)
Last Synced: 2025-04-24T12:49:48.682Z (11 months ago)
Topics: cli-app, command-line-tool, cross-platform, go, golang, golang-tools, update, updater, user-friendly
Language: Go
Homepage:
Size: 10.2 MB
Stars: 399
Watchers: 3
Forks: 17
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-go - gup - Update binaries installed by "go install". (Package Management / HTTP Clients)
awesome-go-with-stars - gup - 02-23 | (Package Management / HTTP Clients)
awesome-go - gup - Update binaries installed by "go install". (Package Management / HTTP Clients)
awesome-go-cn - gup
awesome-go - nao1215/gup - Update binaries installed by "go install" with goroutines. ☆`498` (Package Management / HTTP Clients)
awesome-cli-apps-in-a-csv - gup - Update binaries installed by "go install" with goroutines. (<a name="programming"></a>Programming)
awesome-go - gup - Update binaries installed by "go install". (Package Management / HTTP Clients)
awesome-go - gup - Update binaries installed by "go install". (Package Management / HTTP Clients)
zero-alloc-awesome-go - gup - Update binaries installed by "go install". (Package Management / HTTP Clients)
awesome-cli-apps - gup - Update binaries installed by "go install" with goroutines. (<a name="programming"></a>Programming)
awesome-go-cn - gup
awesome-go-plus - gup - Update binaries installed by "go install". ![stars](https://img.shields.io/badge/stars-396-blue) (Package Management / HTTP Clients)
awesome-go - gup - Update binaries installed by "go install". (Package Management / HTTP Clients)
fucking-awesome-go - gup - Update binaries installed by "go install". (Package Management / HTTP Clients)

README

[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-)

[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)
[![reviewdog](https://github.com/nao1215/gup/actions/workflows/reviewdog.yml/badge.svg)](https://github.com/nao1215/gup/actions/workflows/reviewdog.yml)
![Coverage](https://raw.githubusercontent.com/nao1215/octocovs-central-repo/main/badges/nao1215/gup/coverage.svg)
[![Go Reference](https://pkg.go.dev/badge/github.com/nao1215/gup.svg)](https://pkg.go.dev/github.com/nao1215/gup)
[![Go Report Card](https://goreportcard.com/badge/github.com/nao1215/gup)](https://goreportcard.com/report/github.com/nao1215/gup)
![GitHub](https://img.shields.io/github/license/nao1215/gup)

# gup - Update binaries installed by "go install"

![sample](./doc/img/sample.png)

**gup** command update binaries installed by "go install" to the latest version. gup updates all binaries in parallel, so very fast. It also provides subcommands for manipulating binaries under \$GOPATH/bin (\$GOBIN). It is a cross-platform software that runs on Windows, Mac and Linux.

If you are using oh-my-zsh, then gup has an alias set up. The alias is `gup - git pull --rebase`. Therefore, please make sure that the oh-my-zsh alias is disabled (e.g. $ \gup update).

## Breaking change (v1.0.0)
- The config file format changed from `gup.conf` to `gup.json`.
- `gup.conf` is no longer read by `gup import`.
- The update channel (`latest` / `main` / `master`) is stored per package in `gup.json`.

## Supported OS (unit testing with GitHub Actions)
- Linux
- Mac
- Windows

## How to install
### Use "go install"
If you do not have the Go development environment installed on your system, please install it from the [official website](https://go.dev/doc/install).
```
go install github.com/nao1215/gup@latest
```

### Use homebrew
```shell
brew install nao1215/gup
```

### Use mise-en-place
```shell
mise use -g gup@latest
```

### Install from Package or Binary
[The release page](https://github.com/nao1215/gup/releases) contains packages in .deb, .rpm, and .apk formats. gup command uses the go command internally, so the golang installation is required.

## How to use
### Update all binaries
If you update all binaries, you just run `$ gup update`.

```shell
$ gup update
update binary under $GOPATH/bin or $GOBIN
[ 1/30] github.com/cheat/cheat/cmd/cheat (Already up-to-date: v0.0.0-20211009161301-12ffa4cb5c87 / go1.22.4)
[ 2/30] fyne.io/fyne/v2/cmd/fyne_demo (Already up-to-date: v2.1.3 / go1.22.4)
[ 3/30] github.com/nao1215/gal/cmd/gal (v1.0.0 to v1.2.0 / go1.22.4)
[ 4/30] github.com/matsuyoshi30/germanium/cmd/germanium (Already up-to-date: v1.2.2 / go1.22.4)
[ 5/30] github.com/onsi/ginkgo/ginkgo (Already up-to-date: v1.16.5 / go1.22.4)
[ 6/30] github.com/git-chglog/git-chglog/cmd/git-chglog (Already up-to-date: v0.15.1 / go1.22.4)
:
:
```

### Update the specified binary
If you want to update only the specified binaries, you specify multiple command names separated by space.
```shell
$ gup update subaru gup ubume
update binary under $GOPATH/bin or $GOBIN
[1/3] github.com/nao1215/gup (v0.7.0 to v0.7.1, go1.20.1 to go1.22.4)
[2/3] github.com/nao1215/subaru (Already up-to-date: v1.0.2 / go1.22.4)
[3/3] github.com/nao1215/ubume/cmd/ubume (Already up-to-date: v1.4.1 / go1.22.4)
```

### Exclude binaries during gup update
If you don't want to update some binaries simply specify binaries which should not be updated separated using ',' without spaces as a delimiter.
Also works in combination with --dry-run
```shell
$ gup update --exclude=gopls,golangci-lint //--exclude or -e, this example will exclude 'gopls' and 'golangci-lint'
```

### Update binaries with @main, @master, or @latest
If you want to control update source per binary, use the following options:
- `--main` (`-m`): update by `@main` (fallback to `@master`)
- `--master`: update by `@master`
- `--latest`: update by `@latest`

The selected channel is saved to `gup.json` and reused by future `gup update` runs.
```shell
$ gup update --main=gup,lazygit --master=sqly --latest=air
```

### List up command name with package path and version under $GOPATH/bin
list subcommand print command information under $GOPATH/bin or $GOBIN. The output information is the command name, package path, and command version.
![sample](doc/img/list.png)

### Remove the specified binary
If you want to remove a command under $GOPATH/bin or $GOBIN, use the remove subcommand. The remove subcommand asks if you want to remove it before removing it.
```shell
$ gup remove subaru gal ubume
gup:CHECK: remove /home/nao/.go/bin/subaru? [Y/n] Y
removed /home/nao/.go/bin/subaru
gup:CHECK: remove /home/nao/.go/bin/gal? [Y/n] n
cancel removal /home/nao/.go/bin/gal
gup:CHECK: remove /home/nao/.go/bin/ubume? [Y/n] Y
removed /home/nao/.go/bin/ubume
```

If you want to force the removal, use the --force option.
```shell
$ gup remove --force gal
removed /home/nao/.go/bin/gal
```

### Check if the binary is the latest version
If you want to know if the binary is the latest version, use the check subcommand. check subcommand checks if the binary is the latest version and displays the name of the binary that needs to be updated.
```shell
$ gup check
check binary under $GOPATH/bin or $GOBIN
[ 1/33] github.com/cheat/cheat (Already up-to-date: v0.0.0-20211009161301-12ffa4cb5c87 / go1.22.4)
[ 2/33] fyne.io/fyne/v2 (current: v2.1.3, latest: v2.1.4 / current: go1.20.2, installed: go1.22.4)
:
[33/33] github.com/nao1215/ubume (Already up-to-date: v1.5.0 / go1.22.4)

If you want to update binaries, the following command.
$ gup update fyne_demo gup mimixbox
```

Like other subcommands, you can only check the specified binaries.
```shell
$ gup check lazygit mimixbox
check binary under $GOPATH/bin or $GOBIN
[1/2] github.com/jesseduffield/lazygit (Already up-to-date: v0.32.2 / go1.22.4)
[2/2] github.com/nao1215/mimixbox (current: v0.32.1, latest: v0.33.2 / go1.22.4)

If you want to update binaries, the following command.
$ gup update mimixbox
```
### Export／Import subcommand
Use export/import when you want to install the same Go binaries across multiple systems.
`gup.json` stores import path, binary version, and update channel (`latest` / `main` / `master`).
`import` installs the exact version written in the file.

```json
{
"schema_version": 1,
"packages": [
{
"name": "gal",
"import_path": "github.com/nao1215/gal/cmd/gal",
"version": "v1.1.1",
"channel": "latest"
},
{
"name": "posixer",
"import_path": "github.com/nao1215/posixer",
"version": "v0.1.0",
"channel": "main"
}
]
}
```

By default:
- `gup export` writes to `$XDG_CONFIG_HOME/gup/gup.json`
- `gup import` auto-detects config path in this order:
1) `$XDG_CONFIG_HOME/gup/gup.json` (if exists)
2) `./gup.json` (if exists)

You can always override the path with `--file`.

```shell
※ Environments A (e.g. ubuntu)
$ gup export
Export /home/nao/.config/gup/gup.json

※ Environments B (e.g. debian)
$ gup import
```

`export` can print config content to STDOUT by `--output`. `import` can read a specific file by `--file`.
```shell
※ Environments A (e.g. ubuntu)
$ gup export --output > gup.json

※ Environments B (e.g. debian)
$ gup import --file=gup.json
```

### Generate man-pages (for linux, mac)
man subcommand generates man-pages under /usr/share/man/man1.
```shell
$ sudo gup man
Generate /usr/share/man/man1/gup-bug-report.1.gz
Generate /usr/share/man/man1/gup-check.1.gz
Generate /usr/share/man/man1/gup-completion.1.gz
Generate /usr/share/man/man1/gup-export.1.gz
Generate /usr/share/man/man1/gup-import.1.gz
Generate /usr/share/man/man1/gup-list.1.gz
Generate /usr/share/man/man1/gup-man.1.gz
Generate /usr/share/man/man1/gup-remove.1.gz
Generate /usr/share/man/man1/gup-update.1.gz
Generate /usr/share/man/man1/gup-version.1.gz
Generate /usr/share/man/man1/gup.1.gz
```

### Generate shell completion file (for bash, zsh, fish, PowerShell)
`completion` prints completion scripts to STDOUT when you pass a shell name.
To install completion files into your user environment for bash/fish/zsh, use `--install`.
For PowerShell, redirect the output to a `.ps1` file and source it from your profile.

```shell
$ gup completion bash > gup.bash
$ gup completion zsh > _gup
$ gup completion fish > gup.fish
$ gup completion powershell > gup.ps1

# Install files automatically to default user paths
$ gup completion --install
```

### Desktop notification
If you use gup with --notify option, gup command notify you on your desktop whether the update was successful or unsuccessful after the update was finished.
```shell
$ gup update --notify
```
![success](./doc/img/notify_success.png)
![warning](./doc/img/notify_warning.png)

## Contributing
First off, thanks for taking the time to contribute! ❤️ See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
Developer workflow, quality checklist, and tool management are documented in [CONTRIBUTING.md](./CONTRIBUTING.md).
Contributions are not only related to development. For example, GitHub Star motivates me to develop!

### Star History
[![Star History Chart](https://api.star-history.com/svg?repos=nao1215/gup&type=Date)](https://star-history.com/#nao1215/gup&Date)

## Contact
If you would like to send comments such as "find a bug" or "request for additional features" to the developer, please use one of the following contacts.

- [GitHub Issue](https://github.com/nao1215/gup/issues)

You can use the bug-report subcommand to send a bug report.
```
$ gup bug-report
※ Open GitHub issue page by your default browser
```

## LICENSE
The gup project is licensed under the terms of [the Apache License 2.0](./LICENSE).

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{CHIKAMATSU Naohiro}
💻

_KEINOS
💻

_mattn
💻

_{Justin Lecher}
💻

_{Lincoln Nogueira}
💻

_{Masaya Watanabe}
💻

_memreflect
💻

_Akimo
💻

_rkscv
💻

_{Ville Skyttä}
💻

_{Zephyr Lykos}
💻

_iTrooz
💻

_{Tiago Peczenyj}
💻

_{ICHINOSE Shogo}
📖 💻

_{Jean-Yves LENHOF}
📖

_{Clara Bennett}
📖