2018-08-13 03:38:35 -04:00
|
|
|
# IRC <--> Zulip bridge
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
./irc-mirror.py --irc-server=IRC_SERVER --channel=<CHANNEL> --nick-prefix=<NICK> --stream=<STREAM> [optional args]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
`--stream` is a Zulip stream.
|
2018-08-13 05:46:42 -04:00
|
|
|
`--topic` is a Zulip topic, is optionally specified, defaults to "IRC".
|
2018-08-13 03:38:35 -04:00
|
|
|
|
2019-01-21 18:46:55 -05:00
|
|
|
IMPORTANT: Make sure the bot is subscribed to the relevant Zulip stream!!
|
|
|
|
|
|
2018-08-13 03:38:35 -04:00
|
|
|
Specify your Zulip API credentials and server in a ~/.zuliprc file or using the options.
|
|
|
|
|
|
|
|
|
|
Note that "_zulip" will be automatically appended to the IRC nick provided
|
|
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
|
|
|
|
|
```
|
2018-08-13 05:46:42 -04:00
|
|
|
./irc-mirror.py --irc-server=irc.freenode.net --channel='#python-mypy' --nick-prefix=irc_mirror \
|
|
|
|
|
--stream='test here' --topic='#mypy' \
|
|
|
|
|
--site="https://chat.zulip.org" --user=<bot-email> \
|
|
|
|
|
--api-key=<bot-api-key>
|
2018-08-13 03:38:35 -04:00
|
|
|
```
|
