wordexp/README.md

2.1 KiB
Raw Blame History

wordexp

Gem Version Circle Code Climate Maintainability

A Ruby gem for performing shell word expansion using wordexp. It's like Shellwords turned up to 11. Not only does it split taking quotes into account, but it also expands environment variables and tildes, and runs subcommands in `backticks` or $(dollar parentheses).


Quick start

$ gem install wordexp
require 'wordexp'

cmd = Wordexp.expand("echo 'roof cats' $HOME ~/bin $(date +%F)")
# => ["echo", "roof cats", "/home/queso", "/home/queso/bin", "2022-01-16"]

fork { exec(*cmd) }
# roof cats /home/queso /home/queso/bin 2022-01-16

With that you're half way to a fairly usable shell in Ruby.

Support

If you want to report a bug, or have ideas, feedback or questions about the gem, let me know via GitHub issues and I will do my best to provide a helpful answer. Happy hacking!

License

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

Code of conduct

Everyone interacting in this projects codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Contribution guide

Pull requests are welcome! Make sure that new code is reasonably well tested and all the checks pass. I'm happy to provide a bit of direction and guidance if you're unsure how to proceed with any of these things.