{"id":22475305,"url":"https://github.com/akarzim/parchemin","last_synced_at":"2026-05-03T07:41:58.877Z","repository":{"id":140664065,"uuid":"270014472","full_name":"akarzim/parchemin","owner":"akarzim","description":"Colours the contents of a file according to its age","archived":false,"fork":false,"pushed_at":"2020-06-07T10:40:17.000Z","size":2276,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T20:31:26.590Z","etag":null,"topics":["colorize","dry-rb","git","ruby"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/akarzim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2020-06-06T15:00:23.000Z","updated_at":"2020-06-12T07:44:40.000Z","dependencies_parsed_at":"2023-04-15T14:35:24.427Z","dependency_job_id":null,"html_url":"https://github.com/akarzim/parchemin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akarzim%2Fparchemin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akarzim%2Fparchemin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akarzim%2Fparchemin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akarzim%2Fparchemin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akarzim","download_url":"https://codeload.github.com/akarzim/parchemin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245889252,"owners_count":20688956,"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":["colorize","dry-rb","git","ruby"],"created_at":"2024-12-06T13:15:06.588Z","updated_at":"2026-05-03T07:41:53.830Z","avatar_url":"https://github.com/akarzim.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT SHIELDS --\u003e\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/akarzim/parchemin\"\u003e\n    \u003cimg src=\"images/logo.svg\" alt=\"Logo\" width=\"80\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003eParchemin\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Colours the contents of a file according to its age.\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/akarzim/parchemin\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/akarzim/parchemin/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/akarzim/parchemin/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n## Table of Contents\n\n* [About the Project](#about-the-project)\n  * [Built With](#built-with)\n* [Getting Started](#getting-started)\n  * [Prerequisites](#prerequisites)\n  * [Installation](#installation)\n* [Usage](#usage)\n* [Roadmap](#roadmap)\n* [Contributing](#contributing)\n* [License](#license)\n* [Contact](#contact)\n* [Acknowledgements](#acknowledgements)\n\n## About The Project\n\n**DISCLAIMER**: This is a toy project to play with the [dry-cli][dry-cli] Ruby gem.\n\n[![Parchemin Dark][dark-screenshot]][dark-screenshot]\n[![Parchemin Light][light-screenshot]][light-screenshot]\n\n### Built With\n\n* [dry-cli][dry-cli]\n* [colorize][colorize]\n\n## Getting Started\n\nTo get a local copy up and running follow these simple steps.\n\n### Prerequisites\n\n* [git](https://git-scm.com/downloads)\n\n### Installation\n\n1. Clone the repo\n\n```sh\ngit clone https://github.com/akarzim/parchemin.git\n```\n\n## Usage\n\nIn a terminal, step inside the Parchemin directory and run:\n\n```sh\n❯ ./parchemin --help\nCommands:\n  parchemin color [SUBCOMMAND]\n  parchemin read FILE                         # Read the given file\n  parchemin version                           # Print version\n```\n\nThe main command is `read` which takes some optional arguments:\n\n```sh\n❯ ./parchemin read --help\nCommand:\n  parchemin read\n\nUsage:\n  parchemin read FILE\n\nDescription:\n  Read the given file\n\nArguments:\n  FILE                \t# REQUIRED File to read\n\nOptions:\n  --strategy=VALUE, -s VALUE      \t# Colorization strategy: (scratch/strata/random/none), default: :random\n  --mode=VALUE, -m VALUE          \t# Colorization mode: (dark/light), default: :dark\n  --help, -h                      \t# Print this help\n\nExamples:\n  parchemin read path/to/file                     # Run Parchemin on file\n  parchemin read --strategy=strata path/to/file   # Run Parchemin on file with strata strategy\n  parchemin read --mode=light path/to/file        # Run Parchemin on file using light mode\n```\n\nFor now, 4 strategies are available:\n\n- **none**: just render the git blame output on FILE\n- **random**: pick a random sepia color for each line of FILE\n- **strata**: set each line color according to its age. The oldest, the darkest\n- **scratch**: same as _strata_ but with slight variations on each character.\n\n## Roadmap\n\nSee the [open issues](https://github.com/akarzim/parchemin/issues) for a list of proposed features (and known issues).\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n## Contact\n\nFrançois Vantomme - [@akarzim](https://mastodon.host/@akarzim)\n\nProject Link: \u003chttps://github.com/akarzim/parchemin\u003e\n\n## Acknowledgements\n\n* [Gruvbox][gruvbox] colorscheme\n* [Larry Sanger][globewalldesk] for [this issue on Colorize][colorize-issue]\n* [Othneil Drew][othneildrew] for [this readme template][readme-template]\n\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/akarzim/parchemin.svg?style=flat-square\n[contributors-url]: https://github.com/akarzim/parchemin/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/akarzim/parchemin.svg?style=flat-square\n[forks-url]: https://github.com/akarzim/parchemin/network/members\n[stars-shield]: https://img.shields.io/github/stars/akarzim/parchemin.svg?style=flat-square\n[stars-url]: https://github.com/akarzim/parchemin/stargazers\n[issues-shield]: https://img.shields.io/github/issues/akarzim/parchemin.svg?style=flat-square\n[issues-url]: https://github.com/akarzim/parchemin/issues\n[license-shield]: https://img.shields.io/github/license/akarzim/parchemin.svg?style=flat-square\n[license-url]: https://github.com/akarzim/parchemin/blob/master/LICENSE.txt\n[dark-screenshot]: images/dark-screenshot.png\n[light-screenshot]: images/light-screenshot.png\n[dry-cli]: https://dry-rb.org/gems/dry-cli/0.6/\n[colorize]: https://github.com/fazibear/colorize\n[gruvbox]: https://github.com/morhetz/gruvbox\n[globewalldesk]: https://gitlab.com/globewalldesk\n[colorize-issue]: https://github.com/fazibear/colorize/issues/66\n[othneildrew]: https://github.com/othneildrew\n[readme-template]: https://github.com/othneildrew/Best-README-Template\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakarzim%2Fparchemin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakarzim%2Fparchemin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakarzim%2Fparchemin/lists"}