https://github.com/joehand/standup-friends
IRC + Hypercore Standup bot
https://github.com/joehand/standup-friends
hypercore irc
Last synced: about 1 year ago
JSON representation
IRC + Hypercore Standup bot
- Host: GitHub
- URL: https://github.com/joehand/standup-friends
- Owner: joehand
- License: mit
- Created: 2017-04-07T16:56:29.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-11T19:04:11.000Z (almost 9 years ago)
- Last Synced: 2025-04-23T13:35:22.475Z (about 1 year ago)
- Topics: hypercore, irc
- Language: JavaScript
- Homepage:
- Size: 28.3 KB
- Stars: 13
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# standup-friends
Echo standup messages to a dedicated channel and record them to a [hypercore](https://github.com/mafintosh/hypercore) feed.
[![npm][npm-image]][npm-url]
[![standard][standard-image]][standard-url]
* **Problem:** We have a #standup channel but we'd often get in discussion around standup items people posted and lose everyone's standup message.
* **Solution:** Keep all human messages in a single channel but have a bot echo standup messages to a dedicated channel and a hypercore feed.
For example, we have to channels `#general` and `#standup`:
In `#general` I'd add my standup message for the day:
```
!standup Building a standup bot this morning and then doing hyperdrive SLEEP work next.
```
And the bot would echo it to `#standup`:
```
standup-bot: jhand: Building a standup bot this morning and then doing hyperdrive SLEEP work next.
```
## Install
```
npm install -g standup-friends
```
## Usage
The bot takes messages in one channel `--channel` and echos them to another channel `echo`. This makes it easy to see all standup messages in on place while still allowing discussion in the main channel.
```
standup-friends --cwd=data --channel=#your-irc --echo=#standup-channel
```
Data will be stored in `cwd` via hypercore.
The command will print out a hypercore key. You can then view standup messages via [hyperpipe](https://github.com/mafintosh/hyperpipe):
```
npm install -g hyperpipe
hyperpipe standup-data
```
### Tailing
You can tail an existing standup key and echo it to another channel/server. This is useful if you want to echo on multiple irc servers.
```
standup-friends --cwd=data-tail --echo=#dat --tail=
```
This will store a duplicate of the data in `/data-tail`.
### IRC Commands
```
!status
!standup building things
```
## License
[MIT](LICENSE.md)
[npm-image]: https://img.shields.io/npm/v/standup-friends.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/standup-friends
[travis-image]: https://img.shields.io/travis/joehand/standup-friends.svg?style=flat-square
[travis-url]: https://travis-ci.org/joehand/standup-friends
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[standard-url]: http://npm.im/standard