Linux/Unix/OSX OS Command helpers.
- All commands return a result object (success?, exit_code, stdout, stderr)
- Call a command with #run (returns boolean) or #run! (raises error on failure).
e.g. for rsync
cmd = NixCmds::RsyncCommand.new(
destination_server: 'foo,
destination_user: 'bar',
dry_run: true,
logger: Rails.logger,
)
args = ['--progress', '--recursive' '--times']
result = cmd.run!(args)
puts "Hurray!" if result.success?
# also available
result.exit_code
result.stdout
result stderr
Add this line to your application's Gemfile:
gem 'nix_cmds'
And then execute:
$ bundle
Or install it yourself as:
$ gem install nix_cmds
- rsync
- add more commands
- helpful notifications (logs and stdout)
- verify passed args are supported by command
- come up with helpful interface for command args/flags
- support streaming results
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 tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/mattscilipoti/nix_cmds. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the NixCmds project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.