Terminalwire

Unlike most command-line tools for web services that require an API, Terminalwire streams terminal I/O between a web server and client over WebSockets. This means you can use your preferred command-line parser within your favorite web server framework to deliver a delightful CLI experience to your users.

Installation

Install the gem and add to the application’s Gemfile by executing:

$ bundle add terminalwire

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

$ gem install terminalwire

Rails

Run the intallation command:

$ rails g terminalwire:install my-app

This generates the ./bin/my-app file. Run it to verify that it connects to the server.

$ bin/my-app
Commands:
my-app help [COMMAND] # Describe available commands or one specific command

To edit the command-line, open ./app/cli/main_cli.rb and make changes to the MainCLI class.

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/ruby. 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 a propietary license. Email brad@terminalwire.com to discuss licensing.

Code of Conduct

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