{"id":18716565,"url":"https://github.com/darkguy10/shellplate","last_synced_at":"2025-08-02T23:08:28.579Z","repository":{"id":117970195,"uuid":"443482174","full_name":"DarkGuy10/Shellplate","owner":"DarkGuy10","description":"A neat UI-UX centered boilerplate for shell scripts.","archived":false,"fork":false,"pushed_at":"2022-01-01T07:47:41.000Z","size":362,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-19T12:49:10.308Z","etag":null,"topics":["boilerplate","boilerplate-shell","boilerplate-template","shell","shell-script","template","ui-ux"],"latest_commit_sha":null,"homepage":"https://darkguy10.github.io/Shellplate/","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/DarkGuy10.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG/README.md","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":"2022-01-01T06:10:42.000Z","updated_at":"2024-10-11T15:25:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"0f97f2e8-5e8d-4174-b538-9df878c23c56","html_url":"https://github.com/DarkGuy10/Shellplate","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/DarkGuy10/Shellplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkGuy10%2FShellplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkGuy10%2FShellplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkGuy10%2FShellplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkGuy10%2FShellplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DarkGuy10","download_url":"https://codeload.github.com/DarkGuy10/Shellplate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkGuy10%2FShellplate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268470799,"owners_count":24255391,"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","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["boilerplate","boilerplate-shell","boilerplate-template","shell","shell-script","template","ui-ux"],"created_at":"2024-11-07T13:13:05.737Z","updated_at":"2025-08-02T23:08:28.560Z","avatar_url":"https://github.com/DarkGuy10.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shellplate\n## _A custom boilerplate for shell scripts_\nThis boilerplate does not cover advanced scripting, but focuses more on automating a neat UI/UX for shell scripts. \u003cbr\u003e\nAs someone who occassionally creates shell scripts I made this oriented for self use, so feel free to edit all/any part of the code to match your own styles. \u003cbr\u003e\n_If you do use this code, please give me some credit in the repo :)_ \u003cbr\u003e\n\n## Features\n- Neatly designed UI/UX\n- Stores project data in a JSON file (`project.json`)\n- Built-in dependency checker\n\n## Demo\nYou can find an example script built using Shellplate in the `/example` directory. \u003cbr\u003e\n_Shellplate in use:_\n![Shellplate in use](images/preview1.png)\n\n_An example script built using Shellplate:_\n![An example script built using Shellplate](images/preview2.png)\n\n## Dependencies\nShellplate depends on the following packages which need to be installed manually depending on your platform.\n```\ngit\njq\ncurl\ntput\nfmt\nfiglet\n```\nThese can also be found in `requirements.txt`\n\n## How to use\n1. Open a terminal, clone this repo and cd into the Shellplate directory\n    ```bash\n    git clone https://github.com/DarkGuy10/Shellplate.git\n    cd Shellplate\n    ```\n2. Execute the `Shellplate.sh` script and follow the interactive wizard\n    ```bash\n    bash Shellplate.sh\n    ```\n3. If during the dependency check, any of the packages are marked `UNMET`, manually install them and rerun the script.\n4. Your project is created at `out/\u003cProjectName\u003e/`. Open the `\u003cProjectName\u003e.sh` file in the directory and place your code in the `main()` function.\n5. Happy scripting!\n\n## Features in development\n- Support for custom and prebuilt ANSII-based UI color schemes\n- Built-in script updater\n- Single script-file projects\n- Script flags to skip the interactive wizard\n\n## Documentation\n### Project structure\n```\n\u003cProjectName\u003e/\n    ascii_art.txt\n    \u003cProjectName\u003e.sh\n    project.json\n    README.md\n    requirements.txt\n```\n- `ascii_art.txt` - A banner art for the project created using `figlet`\n- `\u003cProjectName\u003e.sh` - This is the main script file. Put your code inside the `main()` function\n- `project.json` - Contains basic info about the project. It follows the following template:\n    ```json\n    {\n      \"name\": \"\",\n      \"version\": \"\",\n      \"author\": \"\",\n      \"repository\": \"\",\n      \"description\": \"\"\n    }\n    ```\n- `README.md` - The readme file of the project.\n- `requirements.txt` - Contains a list of packages which the script depends to run.\n**NOTE**  : Do not remove `jq` and `tput` from `requirements.txt`. They are important for the boilerplate itself.\n\n### UI/UX Utils\nBy default the `\u003cProjectName\u003e.sh` script file contains a few utility functions for easier UI/UX management.\n- `pretty_banner` - clears the screen and prints a banner showing project name ASCII art and other details\n- `centre \"some text\"` - Print some text in centre of a region of 80 columns (80 is the maximum number of columns in the UI)\n- `header \"some title\"` - Print a bold header in centre, bounded by `[]`\n\n## Changelog\nChangelog can be found [here](CHANGELOG/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarkguy10%2Fshellplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarkguy10%2Fshellplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarkguy10%2Fshellplate/lists"}