{"id":16526077,"url":"https://github.com/markusressel/polybar-addons","last_synced_at":"2025-10-18T07:04:46.746Z","repository":{"id":37328077,"uuid":"375120535","full_name":"markusressel/polybar-addons","owner":"markusressel","description":"A selection of utility programs for displaying stuff in polybar","archived":false,"fork":false,"pushed_at":"2024-09-15T10:55:49.000Z","size":1491,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-09-15T13:03:47.647Z","etag":null,"topics":["addon","polybar","polybar-scripts","template"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/markusressel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-06-08T19:19:55.000Z","updated_at":"2024-09-15T10:55:52.000Z","dependencies_parsed_at":"2023-12-11T19:30:18.054Z","dependency_job_id":"beac0a54-92eb-4e45-bd42-971f406d1903","html_url":"https://github.com/markusressel/polybar-addons","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markusressel%2Fpolybar-addons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markusressel%2Fpolybar-addons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markusressel%2Fpolybar-addons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markusressel%2Fpolybar-addons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markusressel","download_url":"https://codeload.github.com/markusressel/polybar-addons/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219859903,"owners_count":16556031,"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":["addon","polybar","polybar-scripts","template"],"created_at":"2024-10-11T17:25:57.060Z","updated_at":"2025-10-18T07:04:46.652Z","avatar_url":"https://github.com/markusressel.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# polybar-addons\n\nThis repo contains a number of utility programs I use in my [polybar] setup.\n\n## Programs\n\n| Name      | Example                  | Description                                                          |\n|-----------|--------------------------|----------------------------------------------------------------------|\n| `battery` | `00:45`                  | Prints the ETR of usage on battery/charging to full/∞                |\n| `disk`    | `↑ 0.0 B/s ↓ 16.3 B/s`   | Prints the average disk read/write activity since the last call      |\n| `zfs`     | `5% (3.54G), 21% (725G)` | Prints ZFS pool statistics                                           |\n| `network` | `↓ 12.6MB/s ↑ 45.2 B/s`  | Prints the average network send/receive activity since the last call |\n\n### Templating\n\nAlthough all programs have a default output, they also accept an optional \"template\" string. You can use this template\nto modify how the data gathered by the programs is printed. A description of available template placeholders can be\nfound below.\n\nExample:\n\n```shell\n\u003e disk \"Read: %reads% Write: %writes%\"\nRead:   27.2KB/s Write:    2.7MB/s\n```\n\nSince the output of these programs is passed to polybar, you can also include color codes within the template:\n\n```shell\n\u003e disk \"%{F00C853}Read: %reads% Write: %writes%%{FDFDFDF}\"\n%{F00C853}Read:   27.2KB/s Write:    2.7MB/s{FDFDFDF}\n```\n\nColor codes are simply passed on to polybar, which will parse and use them to color the output accordingly.\n\n\n### battery\n\n| Name        | Example | Description                       |\n|-------------|---------|-----------------------------------|\n| `%hours%`   | `01`    | 2 digit padded remaining hours.   |\n| `%minutes%` | `01`    | 2 digit padded remaining minutes. |\n\n### network\n\n| Name            | Example     | Description                                        |\n|-----------------|-------------|----------------------------------------------------|\n| `%received%`    | ` 12.6MB/s` | Monospaced data rate for incoming network traffic. |\n| `%transmitted%` | ` 16.3 B/s` | Monospaced data rate for outgoing network traffic. |\n\n### disk\n\n| Name       | Example     | Description                                     |\n|------------|-------------|-------------------------------------------------|\n| `%reads%`  | ` 12.6MB/s` | Monospaced data rate for reading disk activity. |\n| `%writes%` | ` 16.3 B/s` | Monospaced data rate for writing disk activity. |\n\n### zfs\n\nPlaceholders must be prefixed with the name of the target pool.\n\n| Name            | Example | Description                    |\n|-----------------|---------|--------------------------------|\n| `%rpool.free%`  | `750GB` | Free pool space.               |\n| `%rpool.used%`  | `250GB` | Used pool space.               |\n| `%rpool.cap%`   | `25%`   | Used pool capacity in percent. |\n| `%rpool.total%` | `1TB`   | Total pool size.               |\n\n\n\n## How to use\n\n### Build and \"Install\" (copy to home)\n\nTo build and copy all executables to `~/.config/polybar/scripts`\n\n```shell\ngit clone https://github.com/markusressel/polybar-addons.git\ncd polybar-addons\nmake deploy\n```\n\n### Polybar Config\n\nThen in your polybar config you can use them like this:\n\n```\n\nmodules-right = your_name_of_choice\n\n[...]\n\n[module/your_name_of_choice]\ntype = custom/script\nexec = ~/.config/polybar/scripts/battery \"%{F00C853}%hours%:%minutes%%{FDFDFDF}\"\ninterval = 2\n\n[...]\n\n```\n\n[polybar]: https://github.com/polybar/polybar\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkusressel%2Fpolybar-addons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkusressel%2Fpolybar-addons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkusressel%2Fpolybar-addons/lists"}