{"id":13587766,"url":"https://github.com/hassio-addons/bashio","last_synced_at":"2025-04-14T06:42:26.238Z","repository":{"id":33257512,"uuid":"148055633","full_name":"hassio-addons/bashio","owner":"hassio-addons","description":"Bashio - Home Assistant Community Add-ons","archived":false,"fork":false,"pushed_at":"2024-02-19T06:50:30.000Z","size":225,"stargazers_count":88,"open_issues_count":2,"forks_count":13,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-05-17T00:09:09.039Z","etag":null,"topics":["addons","bash","bash-library","home-assistant","homeassistant"],"latest_commit_sha":null,"homepage":"https://addons.community","language":"Shell","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/hassio-addons.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"frenck","patreon":"frenck","custom":"https://frenck.dev/donate/"}},"created_at":"2018-09-09T18:50:44.000Z","updated_at":"2024-06-18T22:49:22.860Z","dependencies_parsed_at":"2023-11-14T08:29:46.362Z","dependency_job_id":"56adb0d9-813b-472f-8e1c-48891841407d","html_url":"https://github.com/hassio-addons/bashio","commit_stats":{"total_commits":169,"total_committers":13,"mean_commits":13.0,"dds":0.5443786982248521,"last_synced_commit":"c6de3e575614726278e7284e934442c8d7bef4b3"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Fbashio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Fbashio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Fbashio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Fbashio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hassio-addons","download_url":"https://codeload.github.com/hassio-addons/bashio/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248837260,"owners_count":21169373,"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":["addons","bash","bash-library","home-assistant","homeassistant"],"created_at":"2024-08-01T15:06:21.148Z","updated_at":"2025-04-14T06:42:26.214Z","avatar_url":"https://github.com/hassio-addons.png","language":"Shell","readme":"# Home Assistant Community Add-ons: Bashio\n\n[![GitHub Release][releases-shield]][releases]\n![Project Stage][project-stage-shield]\n[![License][license-shield]](LICENSE.md)\n\n[![GitHub Actions][github-actions-shield]][github-actions]\n![Project Maintenance][maintenance-shield]\n[![GitHub Activity][commits-shield]][commits]\n\n[![Discord][discord-shield]][discord]\n\n[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]\n\n[![Support Frenck on Patreon][patreon-shield]][patreon]\n\n## About\n\nBashio is a bash function library for use with Home Assistant add-ons.\n\nIt contains a set of commonly used operations and can be used\nto be included in add-ons to reduce code duplication across add-ons and\ntherefore making it easier to develop and maintain add-ons.\n\nMain goals:\n\n- Reduce the number of operations needed in add-ons.\n- Reduce the amount of code needed in add-ons.\n- Make add-on code more readable.\n- Providing a trusted and tested code base.\n\nQuicker add-on development, by allowing you to focus on the add-on logic\ninstead of other things.\n\n## Installation\n\nThe library is installed in the Home Assistant Community Add-ons base images and\nthe official Home Assistant base images.\n\nCurrently available base images:\n\n- [Home Assistant Community Add-ons Alpine Base Image][base-alpine]\n- [Home Assistant Community Add-ons Alpine Python Base Image][base-alpine-python]\n- [Home Assistant Community Add-ons Debian Base Image][base-debian]\n- [Home Assistant Community Add-ons Ubuntu Base Image][base-ubuntu]\n- [Official Home Assistant Alpine Docker Base Image][home-assistant-base]\n- [Official Home Assistant Alpine Python Docker Base Image][home-assistant-base]\n- [Official Home Assistant Debian Docker Base Image][home-assistant-base]\n- [Official Home Assistant Raspbian Docker Base Image][home-assistant-base]\n- [Official Home Assistant Ubuntu Docker Base Image][home-assistant-base]\n\nUsing those images as the base for your Home Assistant add-on will provide this\nfunction library out of the box. Our base images are updated frequently and\nprovide the minimal needed base image for a great add-on.\n\nIf you want to add Bashio to your own images, please take a look at the\nDockerfile of the above base images to see how they are added at build time.\n\n## Configuration\n\nConfiguring a Bash script to use the Bashio library is fairly easy. Simply\nreplace the shebang of your script file, from `bash` to `bashio`.\n\nBefore example:\n\n```bash\n#!/usr/bin/env bash\nset -e\n\nCONFIG_PATH=/data/options.json\n\nUSERNAME=$(jq --raw-output '.username // empty' $CONFIG_PATH)\n\necho \"${USERNAME}\"\n```\n\nAfter example with Bashio:\n\n```bash\n#!/usr/bin/env bashio\n\nUSERNAME=$(bashio::config 'username')\n\nbashio::log.info \"${USERNAME}\"\n```\n\n## Functions\n\nBashio has more than 250+ functions available: communicating with\nthe Supervisor API, Have I Been Pwned, file system, logging, configuration handling\nand a lot more!\n\nThe best way to get around would be by looking at the different modules\navailable in the [`lib`](lib) folder. Each module has its own file, and each\nfunction has been documented inside the codebase.\n\nFurthermore, Bashio is used by the\n[Home Assistant Community Add-ons project][repository], those add-ons will be\na great resource of practical examples.\n\n## Known issues and limitations\n\n- Some parts of the Supervisor API are not implemented yet.\n\n## Changelog \u0026 Releases\n\nThis repository keeps a change log using [GitHub's releases][releases]\nfunctionality. The format of the log is based on\n[Keep a Changelog][keepchangelog].\n\nReleases are based on [Semantic Versioning][semver], and use the format\nof `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented\nbased on the following:\n\n- `MAJOR`: Incompatible or major changes.\n- `MINOR`: Backwards-compatible new features and enhancements.\n- `PATCH`: Backwards-compatible bugfixes and package updates.\n\n## Support\n\nGot questions?\n\nYou have several options to get them answered:\n\n- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on\n  support and feature requests.\n- You could also [open an issue here][issue] GitHub.\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe have set up a separate document containing our\n[contribution guidelines](CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Authors \u0026 contributors\n\nThe original setup of this repository is by [Franck Nijhof][frenck].\n\nFor a full list of all authors and contributors,\ncheck [the contributor's page][contributors].\n\n## License\n\nMIT License\n\nCopyright (c) 2019-2025 Franck Nijhof\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[base-alpine-python]: https://github.com/hassio-addons/addon-base-python\n[base-alpine]: https://github.com/hassio-addons/addon-base\n[base-debian]: https://github.com/hassio-addons/addon-debian-base\n[base-ubuntu]: https://github.com/hassio-addons/addon-ubuntu-base\n[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/bashio.svg\n[commits]: https://github.com/hassio-addons/bashio/commits/master\n[contributors]: https://github.com/hassio-addons/bashio/graphs/contributors\n[discord-shield]: https://img.shields.io/discord/478094546522079232.svg\n[discord]: https://discord.me/hassioaddons\n[frenck]: https://github.com/frenck\n[github-actions-shield]: https://github.com/hassio-addons/bashio/workflows/CI/badge.svg\n[github-actions]: https://github.com/hassio-addons/bashio/actions\n[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png\n[github-sponsors]: https://github.com/sponsors/frenck\n[home-assistant-base]: https://github.com/home-assistant/docker-base\n[issue]: https://github.com/hassio-addons/bashio/issues\n[keepchangelog]: http://keepachangelog.com/en/1.0.0/\n[license-shield]: https://img.shields.io/github/license/hassio-addons/bashio.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg\n[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png\n[patreon]: https://www.patreon.com/frenck\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg\n[releases-shield]: https://img.shields.io/github/release/hassio-addons/bashio.svg\n[releases]: https://github.com/hassio-addons/bashio/releases\n[repository]: https://github.com/hassio-addons/repository\n[semver]: http://semver.org/spec/v2.0.0\n","funding_links":["https://github.com/sponsors/frenck","https://patreon.com/frenck","https://frenck.dev/donate/","https://www.patreon.com/frenck"],"categories":["Shell"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhassio-addons%2Fbashio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhassio-addons%2Fbashio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhassio-addons%2Fbashio/lists"}