https://github.com/probot/smee-client
🔴 Receives payloads then sends them to your local server
https://github.com/probot/smee-client
Last synced: about 1 year ago
JSON representation
🔴 Receives payloads then sends them to your local server
- Host: GitHub
- URL: https://github.com/probot/smee-client
- Owner: probot
- License: isc
- Created: 2017-10-25T14:53:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-05-06T13:26:05.000Z (about 1 year ago)
- Last Synced: 2025-05-06T14:43:09.919Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://smee.io
- Size: 1.41 MB
- Stars: 483
- Watchers: 17
- Forks: 148
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
smee-client
Client and CLI for smee.io, a service that delivers webhooks to your local development environment.
## Installation
Install the client with:
```sh
npm install -g smee-client
```
## Usage
### CLI
The `smee` command will forward webhooks from smee.io to your local development environment.
```sh
smee
```
Run `smee --help` for usage.
### Node Client
```js
import SmeeClient from '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()
```
#### Proxy Servers
By default, the `SmeeClient` API client makes use of the standard proxy server environment variables.