{"id":16673675,"url":"https://github.com/nathan-fiscaletti/progresscli-go","last_synced_at":"2025-03-13T02:20:40.884Z","repository":{"id":57607767,"uuid":"288020708","full_name":"nathan-fiscaletti/progresscli-go","owner":"nathan-fiscaletti","description":"A progress bar implementation in Golang","archived":false,"fork":false,"pushed_at":"2020-08-16T23:32:44.000Z","size":58,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-19T19:20:32.087Z","etag":null,"topics":["command-line","gui","progress-bar"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nathan-fiscaletti.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-16T20:39:05.000Z","updated_at":"2021-07-15T01:30:02.000Z","dependencies_parsed_at":"2022-08-30T07:42:50.709Z","dependency_job_id":null,"html_url":"https://github.com/nathan-fiscaletti/progresscli-go","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathan-fiscaletti%2Fprogresscli-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathan-fiscaletti%2Fprogresscli-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathan-fiscaletti%2Fprogresscli-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nathan-fiscaletti%2Fprogresscli-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nathan-fiscaletti","download_url":"https://codeload.github.com/nathan-fiscaletti/progresscli-go/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243325058,"owners_count":20273212,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","gui","progress-bar"],"created_at":"2024-10-12T12:27:44.765Z","updated_at":"2025-03-13T02:20:40.860Z","avatar_url":"https://github.com/nathan-fiscaletti.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Progress CLI\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/nathan-fiscaletti/progresscli-go?p=0)](https://goreportcard.com/report/github.com/nathan-fiscaletti/progresscli-go)\n[![GoDoc](https://godoc.org/github.com/nathan-fiscaletti/progresscli-go?status.svg)](https://godoc.org/github.com/nathan-fiscaletti/progresscli-go)\n\nProgress CLI gives you the ability to add customized progress bars to your CLI application.\n\n## Installation\n\n```sh\n$ go get github.com/nathan-fiscaletti/progresscli-go\n```\n\n## Basic Usage\n\n```go\npackage main\n\nimport(\n    \"time\"\n\n    \"github.com/nathan-fiscaletti/progresscli-go\"\n)\n\nfunc main() {\n    bar := progresscli.New()\n    bar.Show()\n\n    for i := float64(0); i \u003c bar.GetMax(); i++ {\n        bar.Increment(1)\n        time.Sleep(time.Millisecond * 25)\n    }\n}\n```\n\n## Custom Styles\n\nYou can implement your own Style for the Progress bar.\n\nThere are several components that make up the progress bar. \n\n![Example Layout](./layout.png)\n\nThe style that would make up the above progress bar would look like this:\n\n```go\nbar.SetLabel(\"Loading\")\nbar.SetStyle(progresscli.Style{\n    OpenChar: \"[\",\n    CloseChar: \"]\",\n    DoneChar: \"*\",\n    NotDoneChar: \"-\",\n    InProgressChar: \"/\",\n    PercentageColor: \"\",\n})\n```\n\nYou can customize the characters used and the bar will automatically adjust it's size accordingly. This includes using multiple characters for different components of the progress bar.\n\n**There are several built in progress bar styles that you can make use of.**\n\n![Built In Styles](./builtin.png)\n\n## Controlling the Progress Bar\n\nYou can set the progress for the progress bar using either the `SetValue(value)` or the `Increment(amount)` functions of the Progress Bar instance.\n\n- `SetValue(value)` will directly set the value of the progress bar.\n- `Increment(amount)` will add `amount` to the current value of the progress bar.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnathan-fiscaletti%2Fprogresscli-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnathan-fiscaletti%2Fprogresscli-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnathan-fiscaletti%2Fprogresscli-go/lists"}