node package manager
Stop wasting time. Easily manage code sharing in your team. Create a free org »



Javascript library for working with WebPipes. Use with Node.js or in the browser.

Build Status


Just include the script. The webpipe object is automagically added to your environment. No need for new or any other sort of initialization.


<script src="webpipe.js"></script>

As a courtesy, offers a compressed and CDN-hosted version:

<script src=""></script>

Or, use a specific version by replacing x.x.x:

<script src=""></script>


Or, if you're using webpipe.js with node.js

$ npm -g install webpipe

Then require the "webpipe" module:

var webpipe = require("webpipe");


webpipe.js exposes two methods: webpipe.execute() and webpipe.options(). Use webpipe.options() to load a WebPipe's Block Definition. It can be handy while debugging and/or learning about new WebPipes. See examples/ for usage examples.

webpipe.execute(url, inputs, callback)

The real workhorse is webpipe.execute(). Use it to make a request to your WebPipe of choice.

webpipe.execute("", { markdown: "*hello world*" }, function (err, data) {
  if (err) return console.log("Error: ", err);
  // Prints the response of the Parse Markdown webpipe. 

Command-line Usage

You can also use webpipe.js from the command-line. To use this feature make sure you install webpipe.js globally.

$ webpipe --markdown "*hello world*"

Store an alias (in ~/.webpipe) so you don't have to type the URL every time:

$ webpipe alias markdown

Prefix a value with @ to read from a file, or - for STDIN:

$ webpipe markdown --markdown
$ cat | ./webpipe markdown --markdown @-

More Examples

See examples/browser/index.html and examples/nodejs/index.js for more examples of usage.


All comments in how to improve this library are very welcome. Feel free post suggestions to the Issue tracker, or even better, fork the repository to implement your own ideas and submit a pull request.


Unless attributed otherwise, everything is under the MIT License (see LICENSE for more info).