https://github.com/erikhuda/thor

Thor is a toolkit for building powerful command-line interfaces.
https://github.com/erikhuda/thor

Last synced: 2 months ago
JSON representation

Thor is a toolkit for building powerful command-line interfaces.

• Host: GitHub
• URL: https://github.com/erikhuda/thor
• Owner: rails
• License: mit
• Created: 2008-05-07T20:07:31.000Z (over 16 years ago)
• Default Branch: main
• Last Pushed: 2024-06-05T07:36:01.000Z (5 months ago)
• Last Synced: 2024-06-23T04:55:54.313Z (5 months ago)
• Language: Ruby
• Homepage: http://whatisthor.com/
• Size: 2.8 MB
• Stars: 5,106
• Watchers: 70
• Forks: 553
• Open Issues: 146
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
Thor

====

[![Gem Version](http://img.shields.io/gem/v/thor.svg)][gem]

[gem]: https://rubygems.org/gems/thor

Description

-----------

Thor is a simple and efficient tool for building self-documenting command line

utilities.  It removes the pain of parsing command line options, writing

"USAGE:" banners, and can also be used as an alternative to the [Rake][rake]

build tool.  The syntax is Rake-like, so it should be familiar to most Rake

users.

Please note: Thor, by design, is a system tool created to allow seamless file and url

access, which should not receive application user input. It relies on [open-uri][open-uri],

which, combined with application user input, would provide a command injection attack

vector.

[rake]: https://github.com/ruby/rake

[open-uri]: https://ruby-doc.org/stdlib-2.5.1/libdoc/open-uri/rdoc/index.html

Installation

------------

    gem install thor

Usage and documentation

-----------------------

Please see the [wiki][] for basic usage and other documentation on using Thor. You can also check out the [official homepage][homepage].

[wiki]: https://github.com/rails/thor/wiki

[homepage]: http://whatisthor.com/

Contributing

------------

If you would like to help, please read the [CONTRIBUTING][] file for suggestions.

[contributing]: CONTRIBUTING.md

License

-------

Released under the MIT License.  See the [LICENSE][] file for further details.

[license]: LICENSE.md