README.md

Usage

Install the Pipedream CLI:

curl https://cli.pipedream.com/install | sh

Then deploy a component:

pd deploy   # prompts you to select a component and pass required options

Check out our quickstart for HTTP Event Sources or review the docs to learn more.

What are components?

Pipedream components are Node.js modules that run code on specific events: HTTP requests, timers, and more. Components are meant to be small, self-contained, and reusable. Components run on Pipedream's infrastructure.

Components are free to run and simple to learn. They come with a built-in key-value store, a props interface, and more.

Components can emit events, which can be retrieved programmatically using the Pipedream CLI, REST API, or SSE. Components that emit events are called event sources.

What are Event Sources?

Event sources turn any API into an event stream, and turn any event stream into an API.

Sources collect data from services like Github, Stripe, the bitcoin blockchain, RSS feeds, and more. They emit new events produced by the service, which can be consumed by any application via REST API or SSE.

Event sources run on Pipedream's infrastructure, but you can retrieve emitted events in your own app using the Pipedream CLI, REST API, or SSE stream tied to your source.

Docs

• What are Event Sources?
• HTTP Event Sources Quickstart
• REST API Reference
• SSE
• CLI Reference

Component API

See the component API docs.

Found a Bug? Have a Feature to suggest?

Any bugs or feature requests for specific components can be raised in this repo as new Github issues or pull requests.

Pipedream also operates a roadmap to solicit feature requests for the Pipedream platform at large (the pipedream.com UI, workflows, the CLI, etc).

You can always reach out to our team - we're happy to discuss feedback or help fix a bug.