Terminal-based Twitter Client. Realtime tweetstream, compose, search , favorite … and much more fun directly from terminal.
Home page : http://www.rainbowstream.org/
Source code : https://github.com/DTVD/rainbowstream
The quick way¶
You will need Python and pip (2.7.x or 3.x).
sudo pip install rainbowstream # Python 3 users: sudo pip3 install rainbowstream
The recommended way¶
virtualenv venv # Python 3 users : use -p to specify your Python 3 localtion as below # virtualenv -p /usr/bin/python3 venv source venv/bin/activate pip install rainbowstream
If you use Linux, you might need to install some packages if you haven’t already. For debian-based distros, these can be installed with
sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev
Besides, Mac OSX Maverick with Xcode 5.1 has a well-known clang unknown argument problem with
Pillow package installation - a dependency of this app.
If you are in this case, I recommend taking a look at Issue #10 and let me know if this workaround doesn’t work for you.
If installation in the quick way doesn’t work:
sudo pip uninstall rainbowstream
- use the virtualenv way above
- `create an issue`_ and provide:
- Your OS
- Your Python version
and see your stream.
I shipped a feature which can display tweet’s images directly on terminal. You can try it with:
rainbowstream -iot # Or rainbowstream --image-on-term
You also can change the config key
True inside the app
to enable above feature,
IMAGE_SHIFT to set image’s margin (relative to your terminal’s width)
IMAGE_MAX_HEIGHT to control max height of every image.
(see config management section).
In the first time you will be asked for authorization of Rainbow Stream app at Twitter. Just click the “Authorize access” button and paste PIN number to the terminal, the rainbow will start.
You might want to use rainbowstream via an HTTP/SOCKS proxy. Proxy settings are provided as follows:
rainbowstream --proxy-host localhost --proxy-port 1337 --proxy-type HTTP # or using the short form: rainbowstream -ph localhost -pp 1337 -pt HTTP
--proxy-type can be omitted. In this case default
8080 and default proxy type
SOCKS5 are used.
The interactive mode¶
While your personal stream is continued, you are also ready to tweet, search, reply, retweet… directly from console. Simply type “h” and hit the Enter key to see the help.
Input is in interactive mode. It means that you can use arrow key to move up and down history, tab-autocomplete or 2 tab to view available suggestion. Input history from previous run is available as well.
Here is full list of supported command:
trendwill show global trending topics.
trend USwill show trends in United States while
trend JP Tokyowill show trends in Tokyo/Japan.
homewill show your timeline.
home 10will print exactly 10 tweets.
notificationwill show your notification from the time you started RainbowStream.
mentionswill show mentions timeline.
mentions 7will show 7 mention tweets.
whois @dtvd88will show profile of @dtvd88.
view @mdowill show @mdo ’s timeline.
view @dmo 9will print exactly 9 tweets.
s noahwill search the word ‘noah’. Result will come back with highlight. Search can be performed with or without hashtag.
t the rainbow is god's promise to noahwill tweet exactly ‘the rainbow is god’s promise to noah’.
rt 12will retweet the tweet with [id=12]. You can see id of each tweet beside the time.
quote 12will quote the tweet with [id=12]. If no extra text is added, the quote will be cancelled.
allrt 12 20will list 20 newest retweets of the tweet with [id=12]. If the number of retweets is not specified, 5 newest retweets will be listed instead.
conversation 12will show the chain of replies prior to the tweet with [id=12].
rep 12 Reallywill reply ‘Really’ to the owner of the tweet with [id=12].
repall 12 Reallywill reply ‘Really’ to all people in the tweet with [id=12].
fav 12will favorite the tweet with [id=12].
ufav 12will unfavorite tweet with [id=12].
share 12will copy link to tweet with [id=12] to your clipboard if you are on a Mac, or display it directly if you are on Linux.
del 12will delete tweet with [id=12].
show image 12will show the image in tweet with [id=12] in your OS’s image viewer.
open 12will open url in tweet with [id=12] in your OS’s default browser.
Direct Messages Commands
inboxwill show inbox messages.
inbox 7will show newest 7 messages.
thread 2will show full thread with [id=2].
mes @dtvd88 hiwill send a
himessage to @dtvd88.
trash 5will remove message with [message_id=5]
Friends and followers Commands
ls flwill list all your followers (people who are following you).
ls frwill list all your friends (people who you are following).
fl @dtvd88will follow @dtvd88.
ufl @dtvd88will unfollow @dtvd88.
mute @dtvd88will mute @dtvd88.
unmute @dtvd88will unmute @dtvd88.
mutingwill list muting users.
block @dtvd88will block @dtvd88.
unblock @dtvd88will unblock @dtvd88.
report @dtvd88will report @dtvd88 as a spam account.
listwill show all lists you are belong to.
list homewill show timeline of list. You will be asked for list’s name.
list all_memwill show list’s all members.
list all_subwill show list’s all subscribers.
list addwill add specific person to a list owned by you.
list rmwill remove specific person from a list owned by you.
list subwill subscribe you to a specific list.
list unsubwill unsubscribe you from a specific list.
list ownwill show all list owned by you.
list newwill create a new list.
list updatewill update a list owned by you.
list delwill delete a list owned by you.
Switching Stream Commands
switch public #AKB48will switch current stream to public stream and track keyword
switch public #AKB48 -fwill do exactly as above but will ask you to provide 2 list:
Only nicksdecide what nicks will be include only.
Ignore nicksdecide what nicks will be exclude.
switch minewill switch current stream to personal stream.
-fwill work as well.
switch listwill switch to a Twitter list’s stream. You will be asked for list name.
- Put anything to terminal, the app will try to eval and display result as a python interactive shell.
101**3like a calculator.
calwill show the calendar for current month.
random_rainbow('wahahaha')will make more fun :)
themewill list available themes.
theme monokaiwill apply monokai theme immediately.
- Changed theme will be remember as the next time’s default theme.
configwill list all config key.
config ASCII_ARTwill output current value of ASCII_ART config key.
config TREND_MAX defaultwill output default value of TREND_MAX config key.
config CUSTOM_CONFIG dropwill drop CUSTOM_CONFIG config key.
config IMAGE_ON_TERM = truewill set value of IMAGE_ON_TERM config key to True.
hwill show the help.
pwill pause the stream.
rwill unpause the stream.
cwill clear the screen.
vwill show version info.
Rainbow Stream is shipped with some default themes.
You can either change theme by
theme command or create your favorite one.
- Tomorrow Night
For detaile information, see theme usage and customization.
Rainbow Stream has a custom config file located at
~/.rainbow_config.json which will be loaded after its default config. You are free to change anything on your custom config, but if you messed up with JSON format, the app would still works fine. Simply overwrite your custom config withe the default config to solve format problems.
You also can view or set a new value of every config key by
config command (See Interactive mode section above).
HEARTBEAT_TIMEOUT: after this timeout (count by minutes), the stream will automatically hangup.
IMAGE_ON_TERM: display tweet’s image directly on terminal.
THEME: current theme.
ASCII_ART: diplay your twitter name by ascii art at stream begin or not.
HIDE_PROMPT: hide prompt after receiving a tweet or not.
PREFIX: display formated string of prompt.
#me: Your username with ‘@’, only available in personal stream.
#place: List name, only available in list stream.
#owner: Owner of list name, only available in list stream.
#keyword: Keyword, only available on public stream.
SEARCH_TYPE: search type in ‘search’ command (‘mixed’,’recent’,’popular’).
SEARCH_MAX_RECORD: max tweets can display on ‘search’ command.
HOME_TWEET_NUM: default tweets to display on ‘home’ command.
RETWEETS_SHOW_NUM: default tweets to display on ‘allrt’ command.
CONVERSATION_MAX: max tweet in a ‘conversation’ thread.
QUOTE_FORMAT: format when quote a tweet
#comment: Your own comment about the tweet
#owner: owner’s username with ‘@’
#tweet: original tweet
THREAD_META_LEFT: format for meta information of messages from partner which is display in the left of screen.
THREAD_META_RIGHT: format for meta information of messages from you which is display in the right of screen.
THREAD_MIN_WIDTH: minimum width of a message frame.
NOTIFY_FORMAT: format of a notification.
MESSAGES_DISPLAY: default messages to display on ‘inbox’ or ‘sent’ command.
TREND_MAX: default trends to display on ‘trend’ command.
LIST_MAX: default tweets to display on ‘list home’ command.
ONLY_LIST: filter list on ‘switch’ command. Eg: [“@fat”,”mdo”]
IGNORE_LIST: ignore list on ‘switch’ command. Eg: [“@fat”]
HISTORY_FILENAME: name of file which stores input history.
IMAGE_SHIFT: left and right margin of image in ‘-iot’/’–image-on-term’ mode.
IMAGE_MAX_HEIGHT: max height of image in ‘-iot’/’–image-on-term’ mode.
STREAM_DELAY: seconds to wait before displaying another tweet, will drop all tweets while waiting. This value can be used to slow down the stream.
USER_DOMAIN: user URL of Twitter Streaming API.
PUBLIC_DOMAIN: public URL of Twitter Streaming API.
SITE_DOMAIN: site URL of Twitter Streaming API.
FORMAT: display format for tweet and message.
CLOCK_FORMAT: time format, see Python’s strftime format.
DISPLAY: decide how tweet will be printed.
#name: Twitter’s name
#nick: Twitter’s screen name
#rt_count: retweets count
#fa_count: favorites count
#fav: favorited symbol
#fav: favorited symbol
#tweet: Tweet’s content
#sender_name: Message’s sender name
#sender_nick: Message’s sender screen name
#to: ‘>>>’ symbol
#recipient_name: Message’s recipient name
#recipient_nick: Message’s recipient screen name
In every format, you can use unicode characters like
Mac users also can use emoji characters as well (Ex:
See Emoji cheatsheet for details.
If you want to build a runnable version yourself, follow these simple steps
Get your Twitter application’s API key and secret
Fork github’s repo and clone in your system.
# Consumer information CONSUMER_KEY = 'APIKey' # Your Twitter application's API key CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
Use pip to install in local
# cd to directory which contains setup.py (cloned directory) virtualenv venv # Python3 users: use -p to specify python3 source venv/bin/activate pip install -e . which rainbowstream # /this-directory/venv/bin/rainbowstream # Remove ~/.rainbow_oauth if exists rainbowstream # local version of rainbowstream