{"id":13858659,"url":"https://github.com/bachya/cliutils","last_synced_at":"2025-05-07T02:22:44.005Z","repository":{"id":15514306,"uuid":"18248570","full_name":"bachya/cliutils","owner":"bachya","description":"A library to alleviate common tasks and headaches in Ruby CLI apps","archived":false,"fork":false,"pushed_at":"2021-12-02T21:02:02.000Z","size":1917,"stargazers_count":12,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-25T20:38:58.565Z","etag":null,"topics":[],"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/bachya.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-03-29T19:11:27.000Z","updated_at":"2023-06-22T20:19:03.000Z","dependencies_parsed_at":"2022-09-16T04:41:50.429Z","dependency_job_id":null,"html_url":"https://github.com/bachya/cliutils","commit_stats":null,"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bachya%2Fcliutils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bachya%2Fcliutils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bachya%2Fcliutils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bachya%2Fcliutils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bachya","download_url":"https://codeload.github.com/bachya/cliutils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242884322,"owners_count":20201108,"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":[],"created_at":"2024-08-05T03:02:16.524Z","updated_at":"2025-03-10T16:31:36.704Z","avatar_url":"https://github.com/bachya.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"CLIUtils\n====\n[![Build Status](https://travis-ci.org/bachya/cliutils.svg?branch=master)](https://travis-ci.org/bachya/cliutils)\n[![Gem Version](https://badge.fury.io/rb/cliutils.svg)](http://badge.fury.io/rb/cliutils)\n[![Coverage Status](http://img.shields.io/coveralls/bachya/cliutils/master.svg)](https://coveralls.io/r/bachya/cliutils?branch=master)\n\nCLIUtils is a library of functionality designed to alleviate common tasks and\nheadaches when developing command-line (CLI) apps in Ruby.\n\n# *Updating from 1.x.x to 2.0.0?*\n\nThe big difference is schema changes for Validators, Behaviors, and Pre-Post\nActions. Make sure you read the [wiki](https://github.com/bachya/cliutils/wiki \"CLIUtils Wiki\").\n\n# Why?\n\nIt's fairly simple:\n\n1. I love developing Ruby-based CLI apps.\n2. I found myself copy/pasting common code from one to another.\n3. I decided to do something about it.\n\n# Libraries\n\nCLIUtils offers:\n\n* **PrettyIO:** some basic CLI sugar\n* **Messaging:** a system to display nicely-formatted messages to one or more tagets\n* **Configuration:** a app configuration manager\n* **Prefs:** a preferences prompter and manager\n\n...along with plenty of documentation:\n\n* [Wiki](https://github.com/bachya/cliutils/wiki \"CLIUtils Wiki\")\n* [YARD documentation](http://rubydoc.info/github/bachya/cliutils/master/frames \"YARD Documentation\")\n\n# Compatibility\n\nCLIUtils is certified against the following:\n\n* Ruby 2.1.1\n* Ruby 2.1.0\n* Ruby 2.0.0\n* Ruby 1.9.3\n\n# Installation\n\nAdd this line to your application's Gemfile:\n\n```bash\n$ gem 'cliutils'\n```\n\nAnd then execute:\n\n```bash\n$ bundle\n```\n\nOr install it yourself:\n\n```bash\n$ gem install cliutils\n```\n\n# Usage\n\n```Ruby\nrequire 'cliutils'\n```\n\nIf you want to mix in everything that CLIUtils has to offer:\n\n```Ruby\ninclude CLIUtils\n```\n\n# Can I use it with...?\n\nI often get asked how nicely CLIUtils plays with other Ruby-based CLI\nlibraries (like Dave Copeland's excellent\n[Methadone](https://github.com/davetron5000/methadone \"Methadone\") and\n[GLI](https://github.com/davetron5000/gli \"GLI\")). Answer: they play very\nnicely. I use CLIUtils in\n[Sifttter Redux](https://github.com/bachya/Sifttter-Redux \"Sifttter Redux\")\n(which is built on GLI) and\n[ExpandSync](https://github.com/bachya/ExpandSync \"ExpandSync\") (which is built\n  on Methadone).\n\n# Bugs and Feature Requests\n\nTo view my current roadmap and objectives, check out the\n[Trello board](https://trello.com/b/qXs7Yeir/cliutils \"CLIUtils on Trello\").\n\nTo report bugs with or suggest features/changes for CLIUtils, please use\nthe [Issues Page](http://github.com/bachya/cliutils/issues).\n\n# Contributing\n\nContributions are welcome and encouraged. To contribute:\n\n1. Fork it (http://github.com/bachya/cliutils/fork)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n  * Make sure you add tests!\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n# License\n\n(The MIT License)\n\nCopyright © 2014 Aaron Bach \u003cbachya1208@gmail.com\u003e\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the 'Software'), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject 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, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbachya%2Fcliutils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbachya%2Fcliutils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbachya%2Fcliutils/lists"}