ishigoemon / wee-slack

A WeeChat plugin for Slack.com. Synchronizes read markers, provides typing notification, search, etc..

wee-slack

A WeeChat native client for Slack.com. Provides supplemental features only available in the web/mobile clients such as: synchronizing read markers, typing notification, search, (and more)! Connects via the Slack API, and maintains a persistent websocket for notification of events.

Features

• New Doesn't use IRC gateway. Connects directly with Slack via API/Websocket

• New Multiple Teams supported! Just add multiple api tokens separated by commas

• New Replays history automatically during startup. (and sets read marker to the correct position in history)

• New Open channels synchronized with Slack. When you open/close a channel on another client it is reflected in wee-slack

• New Colorized nicks in buffer list when used with buffers.pl

• New Colorized nicks in chat

• Supports bidirectional slack read notifications for all channels. (never reread the same messages on the web client or other devices).

• Typing notification, so you can see when others are typing, and they can see when you type. Appears globally for direct messages

• Search slack history allows you to do simple searches across all previous slack conversations

• Away/back status handling

• Expands/shows metadata for things like tweets/links

• Displays edited messages (slack.com irc mode currently doesn't show these)

• Super fun debug mode. See what the websocket is saying with /slack debug

In Development

• cache history pulls
• fix search
• add notification of new versions of wee-slack
• growl notification

Dependencies

• WeeChat 1.0+ http://weechat.org/
• websocket-client https://pypi.python.org/pypi/websocket-client/

Setup

####0.

wee-slack doesn't use the Slack IRC gateway. If you currently connect via the gateway, you should probably remove the server definition.

/server list
    All servers:
        slack
/server del slack
/python reload

####1. Install websocket-client lib

pip install websocket-client

####2. copy wee_slack.py to ~/.weechat/python/autoload

wget https://raw.githubusercontent.com/rawdigits/wee-slack/master/wee_slack.py
cp wee_slack.py ~/.weechat/python/autoload

####3. Start WeeChat

weechat

####4. Add your Slack API key(s)

/set plugins.var.python.slack_extension.slack_api_token (YOUR_SLACK_TOKEN)

^^ (find this at https://api.slack.com/#auth)

If you don't want to store your API token in plaintext you can use the secure features of weechat:

/secure passphrase this is a super secret password
/secure set slack_token (YOUR_SLACK_TOKEN)
/set plugins.var.python.slack_extension.slack_api_token ${sec.data.slack_token}

Optional: If you would like to connect to multiple groups, use the above command with multiple tokens separated by commas. (NO SPACES)

/set plugins.var.python.slack_extension.slack_api_token (token1),(token2),(token3)

###5. $PROFIT$

/save
/python reload

Commands

Join a channel:

/join [channel]
/slack join [channel]

Start a direct chat with someone:

/slack talk [username]

List channels:

/slack channels

List users:

/slack users

Close channel/dm:

/part
/leave
/close

Set yourself away/back:

/slack away
/slack back

Turn off colorized nicks:

/set plugins.var.python.slack_extension.colorize_nicks 0

Set all read markers to a specific time:

/slack setallreadmarkers (time in epoch)

Debug mode:

/slack debug

Optional settings

Show typing notification in main bar (slack_typing_notice):

/set weechat.bar.status.items [buffer_count],[buffer_plugin],buffer_number+:+buffer_name+{buffer_nicklist_count}+buffer_filter,[hotlist],completion,scroll,slack_typing_notice

Show channel name in hotlist after activity

/set weechat.look.hotlist_names_level 14

Support

wee-slack is provided without any warranty whatsoever, but you are welcome to ask questions in #wee-slack on freenode.