Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jgarber623/webmention-cli
A command-line interface for Webmention written in Ruby.
https://github.com/jgarber623/webmention-cli
cli indieweb ruby rubygems webmention
Last synced: 4 months ago
JSON representation
A command-line interface for Webmention written in Ruby.
- Host: GitHub
- URL: https://github.com/jgarber623/webmention-cli
- Owner: jgarber623
- License: mit
- Created: 2018-08-15T02:07:21.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-08-02T00:46:02.000Z (6 months ago)
- Last Synced: 2024-10-05T13:32:12.547Z (4 months ago)
- Topics: cli, indieweb, ruby, rubygems, webmention
- Language: Ruby
- Homepage: https://rubygems.org/gems/webmention-cli
- Size: 124 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# webmention-cli
**A command-line interface for Webmention written in Ruby.**
[](https://rubygems.org/gems/webmention-cli)
[](https://rubygems.org/gems/webmention-cli)
[](https://github.com/jgarber623/webmention-cli/actions/workflows/ci.yml)
## Installation
Before installing and using webmention-cli, you'll want to have [Ruby](https://www.ruby-lang.org) 2.7 (or newer) installed.
```sh
$ gem install webmention-cli
```
## Usage
webmention-cli makes available the following commands:
### `webmention endpoint `
Discover the Webmention endpoint for a `` URL.
```sh
$ webmention endpoint https://sixtwothree.org
https://sixtwothree.org/webmentions
```
The command returns a non-zero exit code if the `` URL does not advertise a Webmention endpoint (or if an HTTP error was encountered).
### `webmention send `
Send a webmention from a `` URL to a `` URL.
```sh
$ 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
```sh
$ 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 `
Confirm whether or not a `` URL links to a `` URL.
```sh
$ 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 `` links to `` and a non-zero exit code in all other cases.
#### Verify a webmention with a vouch URL
```sh
$ 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 `` links to `` _and_ the provided vouch URL links to the ``'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](https://indieweb.org) movement.
webmention-cli is written and maintained by [Jason Garber](https://sixtwothree.org).
## License
webmention-cli is freely available under the [MIT License](https://opensource.org/licenses/MIT). Use it, learn from it, fork it, improve it, change it, tailor it to your needs.