webami

README

webami

A whoami for the internet. Easily retrieve your public IP address from the command-line. webami utilises Ipify to retrieve your public IP address and return it within the command-line.

webami is designed to be a simple way to avoid context-switching (we ❤ terminal!) and provide a simple way to get your public IP should you need to pipe it into things.

[!

Installation

webami is very easy to install:

cd webami
make

Move the resultant "webami" executable to your PATH for easy usage.

Alternatively, you can grab the latest release from the current releases. Release executables are made available for both Linux and Windows.

Usage

There really isn't much to using webami! Once it's compiled, simply use the executable: ./webami

You can specify a different IP retrieval service if you wish. You can do this using the use command:

./webami use <ip retrieval service URL>

e.g:

./webami use https://api.ipify.org

You are free to use whatever IP retrieval service you like, for example your own self-hosted version of Ipify or an alternative service. However, webami expects the output of the service used to follow some simple rules:

• The service must be accessible using either the HTTP or HTTPS protocol.
• The service must present the Content-Type: plain/text.
• The IP address must be the only thing returned in the response body.

To find out the current version of your webami executable, you can use:

./webami version

More features will be added soon and will be documented. However, for a quick assist, the help functionality is an easy way to get it:

./webami help

Contributing

Thank you for wanting to contribute! Any contributions are welcome, feel free to raise a pull request or raise an issue. For anything that may take you time, it is probably worth opening an issue first to discuss.

Credit where credit is due

webami uses Ipify to retrieve your public IP address. It is essentially a command-line wrap around the Ipify API. Ipify is a seperate, unrelated project (maintained by Randall Degges) which has it's source code in a Github Repository.

License