Skip to content

xogroup/bunnybus-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bunnybus-cli

Command line tool for BunnyBus.

npm version Build Status Known Vulnerabilities NSP Status

Lead Maintainer: Lam Chan

Introduction

This is a command line tool for supporting the BunnyBus ecosystem. Support comes in the form of providing a piping utility to bus data via Linux/Unix pipes. The implementation of this tool embodies the ideology around building small specialized components to compose a better whole.

Installation

npm i -g bunnybus-cli

Usage

# Subscribe a live stream of data from a queue to a file.
bunnybus -S -c /path/to/config.json > output.json

# Publish Json formatted string from a file  and push to Rabbit MQ
cat input.json | bunnyBus -P -c /path/to/config.json

# Subscribe a live stream of data and pipe it back to RabbitMQ live stream it to a file
bunnybus -S -c /path/to/config.json | bunnyBus -P -t -c /path/to/config.json > output.json

Documentation

API

See the API Reference.

Examples

Check out the Examples

Contributing

We love community and contributions! Please check out our guidelines before making any PRs.

Setting up for development

  1. Install Docker
  2. Clone this project and cd into the project directory
  3. Run the commands below
[sudo] npm link
npm install
npm run start-docker
npm test
npm run stop-docker

npm link is necessary for the test to function since the test suite executes end to end against the CLI commands.

For normal development/test iterations, there is no need to stop the docker container. When the docker container is already running, just run npm test.