https://github.com/sorairolake/gb3sum
Print and check BLAKE3 checksums
https://github.com/sorairolake/gb3sum
blake3 checksum cli command-line command-line-tool digest go golang hash md5sum terminal tool
Last synced: about 2 months ago
JSON representation
Print and check BLAKE3 checksums
- Host: GitHub
- URL: https://github.com/sorairolake/gb3sum
- Owner: sorairolake
- License: gpl-3.0
- Created: 2024-04-29T13:11:32.000Z (12 months ago)
- Default Branch: develop
- Last Pushed: 2025-02-17T05:42:04.000Z (2 months ago)
- Last Synced: 2025-02-17T06:26:29.704Z (2 months ago)
- Topics: blake3, checksum, cli, command-line, command-line-tool, digest, go, golang, hash, md5sum, terminal, tool
- Language: Go
- Homepage: https://pkg.go.dev/github.com/sorairolake/gb3sum
- Size: 105 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.adoc
- Contributing: CONTRIBUTING.adoc
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS.adoc
Awesome Lists containing this project
README
# gb3sum
[![CI][ci-badge]][ci-url]
[![Go Reference][reference-badge]][reference-url]
![Go version][go-version-badge]
**gb3sum** is a command-line utility for printing and checking [BLAKE3]
checksums.
gb3sum is written in [Go] and compiles into a single binary with no external
dependencies.
## Installation
### From source
```sh
go install github.com/sorairolake/gb3sum@latest
```
### From binaries
The [release page] contains pre-built binaries for Linux, macOS, Windows and
others.
### How to build
Please see [BUILD.adoc].
## Usage
### Basic usage
#### Print BLAKE3 checksums
```sh
echo "Hello, world!" > foo.txt
gb3sum foo.txt | tee b3sums.txt
```
Output:
```text
94f1675bac4f8bc3c593c63dbf5fe78a0bfda01082af85d5b41a65096db56bff foo.txt
```
#### Check BLAKE3 checksums
```sh
gb3sum -c b3sums.txt
```
Output:
```text
foo.txt: OK
```
### Generate shell completion
`--generate-completion` option generates shell completions to standard output.
The following shells are supported:
- `bash`
- `fish`
- `powershell`
- `zsh`
Example:
```sh
gb3sum --generate-completion bash > gb3sum.bash
```
## Command-line options
Please see the following:
- [`gb3sum(1)`]
## Source code
The upstream repository is available at
.
The source code is also available at:
-
-
## Changelog
Please see [CHANGELOG.adoc].
## Contributing
Please see [CONTRIBUTING.adoc].
## Comparisons
`gb3sum` supports a command-line syntax similar but not identical to
coreutils's [`md5sum`].
### Differences to coreutils's md5sum
- `gb3sum` doesn't have options to specify the input mode (`-b` and `-t`).
- `gb3sum` always treats files as binary file.
- `gb3sum` doesn't have an option to terminate output lines with NUL (`-z`).
- `gb3sum` has an option to specify the number of output bytes like coreutils's
[`b2sum`] (`-l`).
### Differences to b3sum
Unlike [`b3sum`], `gb3sum` doesn't support keyed hashing and key derivation.
Use `b3sum` instead of `gb3sum` for those purposes.
## License
Copyright (C) 2024 Shun Sakai (see [AUTHORS.adoc])
1. This program is distributed under the terms of the _GNU General Public
License v3.0 or later_.
2. Some files are distributed under the terms of the _Creative Commons
Attribution 4.0 International Public License_.
This project is compliant with version 3.2 of the [_REUSE Specification_]. See
copyright notices of individual files for more details on copyright and
licensing information.
[ci-badge]: https://img.shields.io/github/actions/workflow/status/sorairolake/gb3sum/CI.yaml?branch=develop&style=for-the-badge&logo=github&label=CI
[ci-url]: https://github.com/sorairolake/gb3sum/actions?query=branch%3Adevelop+workflow%3ACI++
[reference-badge]: https://img.shields.io/badge/Go-Reference-steelblue?style=for-the-badge&logo=go
[reference-url]: https://pkg.go.dev/github.com/sorairolake/gb3sum
[go-version-badge]: https://img.shields.io/github/go-mod/go-version/sorairolake/gb3sum?style=for-the-badge&logo=go
[BLAKE3]: https://github.com/BLAKE3-team/BLAKE3
[Go]: https://go.dev/
[release page]: https://github.com/sorairolake/gb3sum/releases
[BUILD.adoc]: BUILD.adoc
[`gb3sum(1)`]: docs/man/man1/gb3sum.1.adoc
[CHANGELOG.adoc]: CHANGELOG.adoc
[CONTRIBUTING.adoc]: CONTRIBUTING.adoc
[`md5sum`]: https://www.gnu.org/software/coreutils/md5sum
[`b2sum`]: https://www.gnu.org/software/coreutils/b2sum
[`b3sum`]: https://crates.io/crates/b3sum
[AUTHORS.adoc]: AUTHORS.adoc
[_REUSE Specification_]: https://reuse.software/spec/