webmention-cli

A command-line interface for Webmention written in Ruby.

Gem Downloads Build Dependencies Maintainability Coverage

Getting Started

Before installing and using webmention-cli, you'll want to have Ruby 2.4 (or newer) installed. It's recommended that you use a Ruby version managment tool like rbenv, chruby, or rvm.

webmention-cli is developed using Ruby 2.4.5 and is additionally tested against Ruby 2.5.3 and 2.6.0 using Travis CI.

Installation

gem install webmention-cli

Usage

webmention-cli makes available the following commands:

webmention endpoint <url>

Discover the webmention endpoint for the given <url> using the webmention-endpoint-ruby gem's endpoint discovery.

$ webmention endpoint https://sixtwothree.org
https://sixtwothree.org/webmentions

webmention verify <source> <target>

Confirm whether or not a <source> URL links to the given <target> URL using the webmention-verification-ruby gem's verifers.

$ webmention verify https://kartikprabhu.com/notes/re-launching-franciscms https://sixtwothree.org/posts/launching-franciscms-onto-the-indieweb
SUCCESS: https://kartikprabhu.com/notes/re-launching-franciscms links to https://sixtwothree.org/posts/launching-franciscms-onto-the-indieweb

By default, the verify command will strictly match URLs. For a bit more flexibility, use the --no-strict flag:

$ webmention verify https://aaronparecki.com/2014/12/17/5/webmention-indieweb https://sixtwothree.org/posts/open-sourcing-my-webmention-service --no-strict
SUCCESS: https://aaronparecki.com/2014/12/17/5/webmention-indieweb links to https://sixtwothree.org/posts/open-sourcing-my-webmention-service

Contributing

Interested in helping improve webmention-cli? Awesome! Your help is greatly appreciated. See CONTRIBUTING.md for details.

Acknowledgments

webmention-cli wouldn't exist without Webmention and the hard work put in by everyone involved in the IndieWeb movement.

webmention-cli is written and maintained by Jason Garber.

License

webmention-cli is freely available under the MIT License. Use it, learn from it, fork it, improve it, change it, tailor it to your needs.