uptimerobot_cmd

UptimerobotCmd

Command-line client for Uptimerobot service.

Installation

You can add this gem to your projects or you can access directly from command-line. For command-line usage:

gem install uptimerobot_cmd

For library usage, add this line to your application's Gemfile:

gem 'uptimerobot_cmd'

Usage

You need to set an environment variable to use this mini tool. You need Uptimerobot service’s APIKEY. Please set this variable;

export UPTIMEROBOT_APIKEY=YOUR_API_KEY

Also, you can set default contact ID for quick monitoring.

export UPTIMEROBOT_DEFAULT_CONTACT=CONTACT_ID

All commands:

Commands:
  uptimerobot_cmd add                 # Add new service for monitoring
  uptimerobot_cmd contacts            # List current contacts for monitors
  uptimerobot_cmd delete              # Delete monitor
  uptimerobot_cmd help [COMMAND]      # Describe available commands or one specific command
  uptimerobot_cmd list                # List current monitors
  uptimerobot_cmd search NAME or URL  # Search in monitored services
  uptimerobot_cmd version             # Version information

Options:
  [--color], [--no-color]  

add

You can set UPTIMEROBOT_DEFAULT_CONTACT environment variable for default contact. This will help you to add more quicker. You don’t need to pass --contact if you have UPTIMEROBOT_DEFAULT_CONTACT environment variable set.

# without UPTIMEROBOT_DEFAULT_CONTACT
uptimerobot_cmd add http://example.com --contact=1234567
uptimerobot_cmd add http://example.com --name=Example --contact=1234567
uptimerobot_cmd add http://example.com --name="Example Website" --contact=1234567

# with UPTIMEROBOT_DEFAULT_CONTACT
uptimerobot_cmd add http://example.com
uptimerobot_cmd add http://example.com --name=Example
uptimerobot_cmd add http://example.com --name="Example Website"

Will be more features for add soon!

list

Output is sorted by Friendly Name by default. Use --sort= option. Valid values are: name, url and status

uptimerobot_cmd list
uptimerobot_cmd list --sort=url
uptimerobot_cmd list --sort=status

# for colorized output
uptimerobot_cmd list --color
uptimerobot_cmd list --sort=url --color
uptimerobot_cmd list --sort=status --color

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec 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.

Running Tests

Run all tests via bundle exec rake. To run private tests only:

bundle exec rake TEST=test/private_test.rb 

Due to Security and Privacy, most of the test cases are private. You can find example private tests under test/ folder.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/vigo/uptimerobot_cmd. 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.

License

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