Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adhocore/chin
A Go lang library to show a spinner as user waits for any long running jobs to finish.
https://github.com/adhocore/chin
adhocore cli golang spin spinner terminal
Last synced: about 2 months ago
JSON representation
A Go lang library to show a spinner as user waits for any long running jobs to finish.
- Host: GitHub
- URL: https://github.com/adhocore/chin
- Owner: adhocore
- License: mit
- Created: 2022-10-24T04:05:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-10T13:28:15.000Z (11 months ago)
- Last Synced: 2024-10-04T20:36:56.183Z (2 months ago)
- Topics: adhocore, cli, golang, spin, spinner, terminal
- Language: Go
- Homepage: https://github.com/adhocore/chin
- Size: 59.6 KB
- Stars: 33
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-nepal - chin - chin aka spin is shows a spinner as user waits for any long running jobs to finish. (Uncategorized / Uncategorized)
README
# adhocore/chin
[](https://goreportcard.com/report/github.com/adhocore/chin)
[](https://github.com/adhocore/chin/actions/workflows/lint-action.yml)
[](https://twitter.com/intent/tweet?text=Golang+spinner+library+for+the+terminal&url=https://github.com/adhocore/chin&hashtags=golang,terminal,spinner,spin)
[](https://github.com/sponsors/adhocore)
A Golang command line tool to show a spinner as you wait for some long running jobs to finish.
> This is a simple project but carries a tremendous value to me [❤️].
## Usage
Install `chin`:
```sh
go get -u github.com/adhocore/chin
```
Use in Go code with `WaitGroup`:
```go
var wg sync.WaitGroup
s := chin.New().WithWait(&wg)
go s.Start()
// invoke some long running task
// (you can also call s.Stop() from that task)
longTask(&wg)
s.Stop()
wg.Wait()
```
> Refer and run working [examples](./examples/main.go) with: `go run examples/main.go`
### Custom Spinner
You can choose from provided spinner sets `chin.Default`, `chin.Arrows` and `chin.Dots`:
```go
s := chin.New(chin.Arrows)
// or
s := chin.New(chin.Dots)
go s.Start()
```
> `chin.Default` is selected by default so you don't have to specify it.
You can also define your own spinner set with delay and animation chars like so:
```go
// Animates 0 to 4 in a gap of 50ms:
s := chin.New(chin.Set{50*time.Millisecond, []string{"0", "1", "2", "3", "4", "3", "2", "1"}})
go s.Start()
```
## Screen
---
### Other projects
My other golang projects you might find interesting and useful:
- [**gronx**](https://github.com/adhocore/gronx) - Lightweight, fast and dependency-free Cron expression parser (due checker), task scheduler and/or daemon for Golang (tested on v1.13 and above) and standalone usage.
- [**urlsh**](https://github.com/adhocore/urlsh) - URL shortener and bookmarker service with UI, API, Cache, Hits Counter and forwarder using postgres and redis in backend, bulma in frontend; has [web](https://urlssh.xyz) and cli client.
- [**fast**](https://github.com/adhocore/fast) - Check your internet speed with ease and comfort right from the terminal. (It uses `adhocore/chin`.)
- [**goic**](https://github.com/adhocore/goic) - Go Open ID Connect, is OpenID connect client library for Golang, supports the Authorization Code Flow of OpenID Connect specification.
- [**jsonc**](https://github.com/adhocore/jsonc) - Golang JSON parser supporting comments, trailing commas and literal newlines.