Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.18 KB

README.md

File metadata and controls

42 lines (28 loc) · 1.18 KB

smee-client

Client and CLI for smee.io, a service that delivers webhooks to your local development environment.

NPM Build Status Codecov

Looking for probot/smee.io?

Installation

Install the client with:

$ npm install -g smee-client

Usage

CLI

The smee command will forward webhooks from smee.io to your local development environment.

$ smee

Run smee --help for usage.

Node Client

const SmeeClient = require('smee-client')

const smee = new SmeeClient({
  source: 'https://smee.io/abc123',
  target: 'http://localhost:3000/events',
  logger: console
})

const events = smee.start()

// Stop forwarding events
events.close()