https://github.com/ruby/shellwords
Manipulates strings with word parsing rules of UNIX Bourne shell
https://github.com/ruby/shellwords
ruby
Last synced: 7 months ago
JSON representation
Manipulates strings with word parsing rules of UNIX Bourne shell
- Host: GitHub
- URL: https://github.com/ruby/shellwords
- Owner: ruby
- License: other
- Created: 2020-05-22T11:16:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-29T23:55:07.000Z (8 months ago)
- Last Synced: 2025-04-30T00:30:54.159Z (8 months ago)
- Topics: ruby
- Language: Ruby
- Homepage:
- Size: 91.8 KB
- Stars: 22
- Watchers: 34
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: COPYING
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Shellwords
This module manipulates strings according to the word parsing rules
of the UNIX Bourne shell.
The `shellwords()` function was originally a port of shellwords.pl,
but modified to conform to [the Shell & Utilities volume of the IEEE
Std 1003.1-2008, 2016 Edition].
[the Shell & Utilities volume of the IEEE Std 1003.1-2008, 2016 Edition]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/contents.html
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'shellwords'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install shellwords
## Usage
```ruby
require 'shellwords'
argv = Shellwords.split('three blind "mice"')
argv #=> ["three", "blind", "mice"]
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/shellwords.