{"id":13395519,"url":"https://github.com/metal3d/bashsimplecurses","last_synced_at":"2025-05-16T08:00:22.216Z","repository":{"id":33580189,"uuid":"37226582","full_name":"metal3d/bashsimplecurses","owner":"metal3d","description":"A simple curses library made in bash to draw terminal interfaces","archived":false,"fork":false,"pushed_at":"2024-07-16T20:09:14.000Z","size":182,"stargazers_count":869,"open_issues_count":7,"forks_count":116,"subscribers_count":21,"default_branch":"master","last_synced_at":"2024-07-31T17:24:06.608Z","etag":null,"topics":["bash","curses","terminal"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/metal3d.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":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-06-10T22:44:43.000Z","updated_at":"2024-07-31T05:38:00.000Z","dependencies_parsed_at":"2024-01-13T17:11:50.385Z","dependency_job_id":"a4dc8e63-ae7d-465a-b1b6-cc47189ee889","html_url":"https://github.com/metal3d/bashsimplecurses","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal3d%2Fbashsimplecurses","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal3d%2Fbashsimplecurses/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal3d%2Fbashsimplecurses/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal3d%2Fbashsimplecurses/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metal3d","download_url":"https://codeload.github.com/metal3d/bashsimplecurses/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254493382,"owners_count":22080126,"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":["bash","curses","terminal"],"created_at":"2024-07-30T17:02:03.946Z","updated_at":"2025-05-16T08:00:22.159Z","avatar_url":"https://github.com/metal3d.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# Bash Simple Curses\n\n[![Documentation Status](https://readthedocs.org/projects/bashsimplecurses/badge/?version=master)](https://bashsimplecurses.readthedocs.io/en/master/?badge=master)\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmetal3d%2Fbashsimplecurses.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmetal3d%2Fbashsimplecurses?ref=badge_shield)\n                \n\nBash Simple Curses gives you some basic functions to quickly create windows on your terminal.\n\nAn example is given: bashbar. Bashbar is a monitoring bar that you can integrate into tiling window managers.\n\nThe (unfinished) goal of Bash Simple Curses is to create windows. It is only intended to create colored windows and display information into. But, [with a little tips](https://bashsimplecurses.readthedocs.io/en/master/tips/), you can also make it interactive.\n\nTo use this library, you have to import `simple_curses.sh` into your bash script, like so:\n\n```bash\n\n#!/bin/bash\n\n# import library, please check path\n#source /usr/lib/simple_curses.sh\nsource /usr/local/lib/simple_curses.sh\n\n# You must create a \"main\" function:\nmain () {\n    # Your code here, here we add some windows and text\n    window \"title\" \"color\"\n    append \"Text...\"\n    endwin\n}\n\n# Then, execute the loop every second ( -t 1 =\u003e 1s)\nmain_loop -t 1\n```\n\nThat's all.\n\n\n## Example\n\n```bash\n#!/bin/bash\nsource simple_curses.sh\n\nmain(){\n    # create a window\n    window \"Example\" \"blue\" \"50%\"\n        append \"Hello world\"\n        addsep\n        append \"The date command\"\n        append_command \"date\"\n    endwin\n\n    # move on the next column\n    col_right\n\n    # and create another window\n    window \"Example 2\" \"red\" \"50%\"\n        append \"Hello world\"\n        addsep\n        append \"The date command\"\n        append_command \"date\"\n    endwin\n}\nmain_loop\n```\n\n![Simple example](docs/images/bsc-example.png)\n\n\n## Install\n\nThere are several possibilities to use the library. We recommend to copy `simple_curses.sh` inside your project and to \"source\" it.\n\nBut, if you want to make it available for the entire system, or for local user, you can use the `make install` command:\n\n```bash\n# install inside the system\n# in /usr/local/lib\nsudo make install\n\n# for local user, no need to use sudo, but change the PREFIX\nmake install PREFIX=~/.local/lib\n```\n\nYou can then uninstall the library file:\n\n```bash\nsudo make uninstall\nmake uninstall PREFIX=~/.local/bin\n```\n\n## License\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmetal3d%2Fbashsimplecurses.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmetal3d%2Fbashsimplecurses?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetal3d%2Fbashsimplecurses","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetal3d%2Fbashsimplecurses","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetal3d%2Fbashsimplecurses/lists"}