Hit Me Up

Fetch name availability, server statuses, tweets, and lots of other information through plugins.

Hit Me Up is a tool for fetching all sorts of information through plugins hosted on npm. Information can include things like name availability on services (like GitHub and Slack), checking server statuses, fetching tweets, and many other possibilities.

Getting Started

First, you want to install the hmu CLI globally from npm:

$ npm install --global hmu

Installing Plugins

You can also install plugins globally with npm:

$ npm install --global hmu-npm hmu-gh hmu-slack

(This will install hmu-gh, hmu-npm, and hmu-slack to start you off)

You can find plugins from npm's hmu-plugin keyword index and install them globally too.

Running Plugins

Plugins can be ran very simply through the hmu CLI. You specify the plugin name, and then input and options after it... For example:

$ hmu npm foo bar --qux

In this example, npm is the plugin, foo and bar are the input, and qux is an option.

The basic usage follows:

$ hmu <name> [...args]

Now, onto slightly more advanced usage, you can run multiple plugins at once by separating them with a comma (,):

$ hmu npm foo, gh bar

In this example, we have the plugins npm and gh, and their inputs foo and bar respectively.

You can also "spread" one input between multiple plugins by separating the names with a tilde (~) like so:

$ hmu npm~gh foo bar

This is equivalent to doing:

$ hmu npm foo bar, gh foo bar

Plugins that are named unconventionally and don't start with hmu- can be ran if you start the name with the at symbol (@):

$ npm install --global some-plugin
# ...
$ hmu @some-plugin foo bar

Also See

• hmu-core: The core that the CLI is based on top of. All plugins are compatible with the core.
• Writing a Hit Me Up plugin.

Credits

| | |:---:| | Jamen Marzonie |

License

MIT © Jamen Marzonie