Skip to content

Latest commit

 

History

History
80 lines (49 loc) · 3.15 KB

README.md

File metadata and controls

80 lines (49 loc) · 3.15 KB
Raw

webmention-cli

A command-line interface for Webmention written in Ruby.

Gem Downloads Build

Installation

Before installing and using webmention-cli, you'll want to have Ruby 2.7 (or newer) installed.

$ gem install webmention-cli

Usage

webmention-cli makes available the following commands:

webmention endpoint <target>

Discover the Webmention endpoint for a <target> URL.

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

The command returns a non-zero exit code if the <target> URL does not advertise a Webmention endpoint (or if an HTTP error was encountered).

webmention send <source> <target>

Send a webmention from a <source> URL to a <target> URL.

$ webmention send https://sixtwothree.org/posts/an-engineer-walks-into-a-design-sprint https://adactio.com/journal/6246
202 Accepted

The command will return either an HTTP status or the value of the response's Location header (if provided and the response's HTTP status is 201 Created).

A non-zero exit code is returned if the HTTP status is not within the 200 range (or if an HTTP error was encountered).

Send a webmention with a vouch URL

$ webmention send https://sixtwothree.org/posts/now-accepting-webmentions https://aaronparecki.com --vouch https://adactio.com/links/9229
202 Accepted

The command with a vouch URL included responds in the same fashion as noted above.

webmention verify <source> <target>

Confirm whether or not a <source> URL links to a <target> URL.

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

The command will return a zero exit code if <source> links to <target> and a non-zero exit code in all other cases.

Verify a webmention with a vouch URL

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

The command will return a zero exit code if <source> links to <target> and the provided vouch URL links to the <source>'s domain. A non-zero exist code is returned in all other cases.

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.