https://github.com/Gelio/go-global-update
A command to update globally installed go executables
https://github.com/Gelio/go-global-update
cli go golang update-checker
Last synced: over 1 year ago
JSON representation
A command to update globally installed go executables
- Host: GitHub
- URL: https://github.com/Gelio/go-global-update
- Owner: Gelio
- License: mit
- Created: 2021-08-29T06:27:11.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-13T10:27:16.000Z (almost 2 years ago)
- Last Synced: 2024-09-13T23:48:17.079Z (almost 2 years ago)
- Topics: cli, go, golang, update-checker
- Language: Go
- Homepage:
- Size: 131 KB
- Stars: 141
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# go-global-update
Update globally installed go binaries.
The missing go command similar to `npm -g update` or
[cargo install-update](https://github.com/nabijaczleweli/cargo-update).
## Table of contents
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Upgrading `go-global-update`](#upgrading-go-global-update)
- [Troubleshooting](#troubleshooting)
- [How it works](#how-it-works)
- [Alternative tools](#alternative-tools)
- [Contributing](#contributing)
## Requirements
- Go 1.16 or higher
## Installation
```sh
go install github.com/Gelio/go-global-update@latest
```
## Usage
Running
```sh
go-global-update
```
will print information about currently installed global binaries and attempt to
upgrade those that have newer versions.
You can also do a dry run without update the binaries:
```sh
go-global-update --dry-run
```
or update just a handful of binaries:
```sh
go-global-update gofumpt
```
For more information, see
```sh
go-global-update --help
```
## Upgrading `go-global-update`
`go-global-update` will take care of updating itself when it updates other
binaries.
## Troubleshooting
Do you have problems updating some binaries using `go-global-update`? Take a
look at [TROUBLESHOOTING.md](./TROUBLESHOOTING.md) for more information.
## How it works
`go-global-update` consists of the following steps:
1. Determine binaries to inspect.
Either use the list of provided arguments or all executables installed in
your `go env GOBIN` (or `$(go env GOPATH)/bin`).
1. Inspect where each executable came from (by running
`go version -m [executable name]` and checking the `path`),
1. Check the latest version for each binary using
`go list -m -f "{{.Version}}" [path]`
1. If the binary has a newer version, run `go install [package path]@latest` to
update it.
## Alternative tools
`go-global-update` is not the only tool trying to solve the problem of updating
globally-installed go binaries. The alternatives are:
- [gup](https://github.com/nao1215/gup)
Advantages:
- includes desktop notifications
- has a subcommand to remove a binary
- has a way to export/import a list of binaries
Disadvantages:
- does not offer troubleshooting information when an upgrade fails
- does not report error logs from failed updates
- updates binaries installed from source (potentially overwrites locally-made
changes)
- [binstale](https://github.com/shurcooL/binstale)
Disadvantages:
- seems not to detect globally-installed binaries using go modules
```sh
$ binstale
binstale
(no source package found)
go-global-update
stale: github.com/Gelio/go-global-update (stale dependency: github.com/Gelio/go-global-update/internal/colors)
gofumpt
(no source package found)
gotop
(no source package found)
misspell
(no source package found)
shfmt
```
## Contributing
Contributions are welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for more
information.