Skip to content

A library for testing interactive command-line applications

License

Notifications You must be signed in to change notification settings

terminalwire/pity

Repository files navigation

Pity

Pity is a gem that helps test command-line interfaces, terminal apps, REPLs, or whatever you want to call them. It uses the PTY gem and IO#select to interact with the gem and a core DSL that looks like this:

REPL.new do |it|
  it.puts "ls"
  it.gets # Prints the contents of the `ls` command
end

Installation

bundle add pity

If bundler is not being used to manage dependencies, install the gem by executing:

gem install pity

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/terminalwire/pity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Pity project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

A library for testing interactive command-line applications

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published