{"id":23092981,"url":"https://github.com/theamallalgi/colorscripts","last_synced_at":"2025-05-01T12:54:31.613Z","repository":{"id":267647653,"uuid":"899685545","full_name":"theamallalgi/colorscripts","owner":"theamallalgi","description":"collection of tons of colorscripts, use the program to use your favourite one, or even a random one each time!","archived":false,"fork":false,"pushed_at":"2024-12-17T14:36:10.000Z","size":1636,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-01T12:54:08.742Z","etag":null,"topics":["art","colorscripts","terminal"],"latest_commit_sha":null,"homepage":"","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/theamallalgi.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":"2024-12-06T19:38:58.000Z","updated_at":"2025-02-20T13:23:43.000Z","dependencies_parsed_at":"2024-12-11T16:21:18.955Z","dependency_job_id":"1411cbcb-99a5-4098-b96a-245e8d215d16","html_url":"https://github.com/theamallalgi/colorscripts","commit_stats":null,"previous_names":["theamallalgi/colorscripts"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theamallalgi%2Fcolorscripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theamallalgi%2Fcolorscripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theamallalgi%2Fcolorscripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theamallalgi%2Fcolorscripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theamallalgi","download_url":"https://codeload.github.com/theamallalgi/colorscripts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251879122,"owners_count":21658691,"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":["art","colorscripts","terminal"],"created_at":"2024-12-16T21:46:08.899Z","updated_at":"2025-05-01T12:54:31.591Z","avatar_url":"https://github.com/theamallalgi.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Intro](https://github.com/theamallalgi/colorscripts/blob/main/dependencies/intro.png?raw=true)\n# Colorscripts 📺\na handy cli tool that will help you show off your terminal/shell with beautiful ansi art that matches your current theme!\n\n\u003e [!NOTE]\n\u003e This project was inspired by [shell-colorscripts](https://gitlab.com/dwt1/shell-color-scripts), by [Derek Taylor](https://gitlab.com/dwt1) (on gitlab)\n\n## Gallery\n\n![example-shot-1](https://github.com/theamallalgi/colorscripts/blob/main/dependencies/shot-1.jpg?raw=true)\n\nrefer to my [dotfiles](https://github.com/theamallalgi/dotfiles) for the setup.\n\u003cdetails\u003e\n    \u003csummary\u003ehere's a bunch of other example shots of the colorscripts in action.\u003c/summary\u003e\n\u003c/br\u003e\n    \n![example-shot-2](https://github.com/theamallalgi/colorscripts/blob/main/dependencies/shot-2.jpg?raw=true)\n\n![example-shot-3](https://github.com/theamallalgi/colorscripts/blob/main/dependencies/shot-3.jpg?raw=true)\n\u003c/details\u003e\n\n## Usage\n\ndefault usage\n\n```bash\ncolorscript [OPTION] [SCRIPT NAME or INDEX]\n```\n\nhere's a list of available commands\n\n| **command**                   | **description**                                                                                  |\n|-------------------------------|--------------------------------------------------------------------------------------------------|\n| `-h`, `--help`, `help`        | display the help message with a summary of all available commands.                              |\n| `-l`, `--list`, `list`        | list all installed color scripts with their respective index numbers and names.                 |\n| `-r`, `--random`, `random`    | run a random color script.                                                                      |\n| `-e`, `--exec`, `exec`        | run a specified color script by its name or index.                                              |\n| `-b`, `--blacklist`, `blacklist` | blacklist a specific color script by its name or index, moving it to the blacklisted directory.    |\n| `-u`, `--unblacklist`, `unblacklist` | unblacklist a previously blacklisted script, moving it back to the main directory.              |\n| `-a`, `--all`, `all`          | display the output of all color scripts, showing their names alongside their respective artwork. |\n\n## Installation\n\n- currently there are 3 ways to install the cli\n- use the `install.sh` script\n- scoop (currently not working, as we are waiting for the package approval from scoop)\n- build it from source (with make)\n\n### 1. Use Scoop\n\n```bash\nscoop install colorscript # install and setup colorscripts\n```\n\n### 2. Use `install.sh` script\n\nclone the repo, and proceed to the directory\n```bash\ngit clone https://github.com/theamallalgi/colorscripts.git # clone git repo\ncd colorscripts # change directory to colorscripts/\n```\n\nrun the install script with sudo privileges\n```sh\nsudo ./install.sh # run install script\n```\n\nrun the cli for the first time\n```sh\ncolorscript --random # displays a random colorscript\n```\n\n### 3. Build from Source\n\nclone the repo, and proceed to the directory\n```bash\ngit clone https://github.com/theamallalgi/colorscripts.git # clone git repo\ncd colorscripts # change directory to colorscripts/\n```\n\nmake sure that `make` is installed on your os\n```sh\nmake install # build and install colorscripts\n```\n\nrun the cli for the first time\n```sh\ncolorscript --random # displays a random colorscript\n```\n\n## Contributions\n\nwe welcome contributions from the community! Here are some guidelines to follow when contributing to the `colorscripts` project:\n\n**Commit Messages:**\n\n* We follow the conventional commit message format. This ensures consistency and helps track changes effectively.\n* Use the prefix `feat(ansi):` for commits that add new ANSI color art scripts to the repository.\n\n**Adding New Art:**\n\n* Create your art using ANSI color escape sequences.\n* Ensure the art utilizes only the terminal's 8-color palette for broad compatibility.\n* Save your art script as a simple filename (e.g., `spiral`, `firework`) in the `colorscripts` folder, avoiding extensions like `.sh`.\n* Use hyphens (-) for separators in filenames if needed.\n* When adding a new art script, commit your changes with the following format:\n```sh\nfeat(ansi): add art-name colorscript\n```\n\n**Example Commit Message:**\n\n```sh\nfeat(ansi): add fire-wave colorscript\n```\n\nThis message indicates that you've added a new colorscript named `fire-wave` that utilizes ANSI color codes.\n\n**Additional Notes:**\n\n* Feel free to open an issue or pull request to discuss your art contribution before starting.\n* We appreciate any suggestions for improvement or bug fixes.\n* Refer to the existing code for reference on how to structure your new art script.\n\nBy following these guidelines, you can help us make `colorscripts` even more vibrant and visually engaging!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheamallalgi%2Fcolorscripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheamallalgi%2Fcolorscripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheamallalgi%2Fcolorscripts/lists"}