{"id":13489938,"url":"https://github.com/cheggaaa/pb","last_synced_at":"2025-05-12T03:41:09.525Z","repository":{"id":5790658,"uuid":"7004897","full_name":"cheggaaa/pb","owner":"cheggaaa","description":"Console progress bar for Golang","archived":false,"fork":false,"pushed_at":"2025-03-10T02:13:12.000Z","size":358,"stargazers_count":3680,"open_issues_count":22,"forks_count":271,"subscribers_count":39,"default_branch":"master","last_synced_at":"2025-05-09T01:14:38.232Z","etag":null,"topics":["go","progress-bar","terminal"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cheggaaa.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-12-04T18:38:14.000Z","updated_at":"2025-05-02T20:58:45.000Z","dependencies_parsed_at":"2022-06-29T12:30:54.437Z","dependency_job_id":"c080da36-787d-4a12-8251-9f175d38a204","html_url":"https://github.com/cheggaaa/pb","commit_stats":{"total_commits":269,"total_committers":79,"mean_commits":"3.4050632911392404","dds":0.5130111524163569,"last_synced_commit":"d0803d4621f50a43a44c25bd7ade182098b56418"},"previous_names":[],"tags_count":55,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheggaaa%2Fpb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheggaaa%2Fpb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheggaaa%2Fpb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheggaaa%2Fpb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cheggaaa","download_url":"https://codeload.github.com/cheggaaa/pb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253351734,"owners_count":21895027,"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":["go","progress-bar","terminal"],"created_at":"2024-07-31T19:00:38.213Z","updated_at":"2025-05-12T03:41:09.499Z","avatar_url":"https://github.com/cheggaaa.png","language":"Go","readme":"# Terminal progress bar for Go\n\n[![Coverage Status](https://coveralls.io/repos/github/cheggaaa/pb/badge.svg)](https://coveralls.io/github/cheggaaa/pb)\n\n## Installation\n\n```\ngo get github.com/cheggaaa/pb/v3\n```\n\nDocumentation for v1 bar available [here](README_V1.md).\n\n## Quick start\n\n```Go\npackage main\n\nimport (\n\t\"time\"\n\n\t\"github.com/cheggaaa/pb/v3\"\n)\n\nfunc main() {\n\tcount := 100000\n\n\t// create and start new bar\n\tbar := pb.StartNew(count)\n\n\t// start bar from 'default' template\n\t// bar := pb.Default.Start(count)\n\n\t// start bar from 'simple' template\n\t// bar := pb.Simple.Start(count)\n\n\t// start bar from 'full' template\n\t// bar := pb.Full.Start(count)\n\n\tfor i := 0; i \u003c count; i++ {\n\t\tbar.Increment()\n\t\ttime.Sleep(time.Millisecond)\n\t}\n\n\t// finish bar\n\tbar.Finish()\n}\n```\n\nResult will be like this:\n\n```\n\u003e go run test.go\n37158 / 100000 [----------------\u003e_______________________________] 37.16% 916 p/s\n```\n\n## Settings\n\n```Go\n// create bar\nbar := pb.New(count)\n\n// refresh info every second (default 200ms)\nbar.SetRefreshRate(time.Second)\n\n// force set io.Writer, by default it's os.Stderr\nbar.SetWriter(os.Stdout)\n\n// bar will format numbers as bytes (B, KiB, MiB, etc)\nbar.Set(pb.Bytes, true)\n\n// bar use SI bytes prefix names (B, kB) instead of IEC (B, KiB)\nbar.Set(pb.SIBytesPrefix, true)\n\n// set custom bar template\nbar.SetTemplateString(myTemplate)\n\n// check for error after template set\nif err := bar.Err(); err != nil {\n    return\n}\n\n// start bar\nbar.Start()\n```\n\n## Progress bar for IO Operations\n\n```Go\npackage main\n\nimport (\n\t\"crypto/rand\"\n\t\"io\"\n\t\"io/ioutil\"\n\n\t\"github.com/cheggaaa/pb/v3\"\n)\n\nfunc main() {\n\tvar limit int64 = 1024 * 1024 * 500\n\n\t// we will copy 500 MiB from /dev/rand to /dev/null\n\treader := io.LimitReader(rand.Reader, limit)\n\twriter := ioutil.Discard\n\n\t// start new bar\n\tbar := pb.Full.Start64(limit)\n\n\t// create proxy reader\n\tbarReader := bar.NewProxyReader(reader)\n\n\t// copy from proxy reader\n\tio.Copy(writer, barReader)\n\n\t// finish bar\n\tbar.Finish()\n}\n```\n\n## Custom Progress Bar templates\n\nRendering based on builtin [text/template](https://pkg.go.dev/text/template) package. You can use existing pb's elements or create you own.\n\nAll available elements are described in the [element.go](v3/element.go) file.\n\n#### All in one example:\n\n```Go\ntmpl := `{{ red \"With funcs:\" }} {{ bar . \"\u003c\" \"-\" (cycle . \"↖\" \"↗\" \"↘\" \"↙\" ) \".\" \"\u003e\"}} {{speed . | rndcolor }} {{percent .}} {{string . \"my_green_string\" | green}} {{string . \"my_blue_string\" | blue}}`\n\n// start bar based on our template\nbar := pb.ProgressBarTemplate(tmpl).Start64(limit)\n\n// set values for string elements\nbar.Set(\"my_green_string\", \"green\").Set(\"my_blue_string\", \"blue\")\n```\n","funding_links":[],"categories":["Go","开源类库","Misc","Open source library","lib"],"sub_categories":["命令行","Command Line"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheggaaa%2Fpb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheggaaa%2Fpb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheggaaa%2Fpb/lists"}