Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
My always up-to-date WeeChat configuration (weechat-dev)

WeeChat Screenshot

Enable mouse support

/mouse enable

Encrypted password in sec.conf

/secure passphrase <pass>
/secure set bncpass <pass>
/secure set relaypass <pass>
/secure set bitlbeepass <pass>
/secure set pushbulletapikey <key>


Default settings on server creation

/set irc.server_default.nicks r3m
/set irc.server_default.ssl_verify off
/set irc.server_default.capabilities "account-notify,away-notify,cap-notify,multi-prefix,server-time,"

the last line request some IRCv3 capabilities. Capabilities supported by WeeChat are: account-notify, away-notify, cap-notify, extended-join, multi-prefix, server-time, userhost-in-names. See IRCv3 Specifications to learn more about IRCv3 capabilities.

Network-specific settings

/server add bitlbee -ssl -autoconnect
/set irc.server.bitlbee.password r3m/bitlbee:${}
/set irc.server.bitlbee.command /msg &bitlbee identify;/oper anything ${}

/server add freenode -ssl -autoconnect
/set irc.server.freenode.password r3m/freenode:${}

/server add snoonet -ssl -autoconnect
/set irc.server.snoonet.password r3m/snoonet:${}

/server add oftc -ssl -autoconnect
/set irc.server.oftc.password r3m/oftc:${}

/connect -all

Once you're connected to bitlbee, WeeChat will send a PRIVMSG to the &bitlbee channel to ask BitlBee to use the /oper command to identify. This is more secure because you're password will not be echoed on the screen and will not appears in logs files. This command will send a message to the &bitlbee channel successfully even if you aren't yet on &bitlbee. &bitlbee channel is not +n.


Plugins to load at startup

/set weechat.plugin.autoload "*,!lua,!tcl,!ruby,!fifo,!xfer,!guile,!javascript"

this will load all module except lua, tcl, ruby, fifo and xfer


/set aspell.check.default_dict en
/set aspell.check.suggestions 3
/set aspell.color.suggestions *green
/aspell enable

Set the dictionnary based on the channel name

/trigger add setdict signal *,irc_in2_join
/trigger set setdict conditions "${nick} == ${info:irc_nick,${server}} && ${channel} =~ [.-](fr|it|es)$ && ${aspell.dict.irc.${server}.${channel}} =="
/trigger set setdict regex "/.*[.-](fr|it|es)$/${re:1}/"
/trigger set setdict command "/set aspell.dict.irc.${server}.${channel} ${tg_signal_data}"

This trigger will set the french dictionnary for channel ending in .fr and -fr Same for it and es.

Note: we will add the suggestions to the statusbar later.


/relay sslcertkey
/relay add ssl.weechat <port>
/set ${}

If you want a trusted certificate, use let's encrypt! with weechat relay.

Note: Even if I use a bouncer (ZNC), this is quite useful to enable relay. Like this you have access to all IRC client (ZNC) and all weechat remote interface (WeeChat Relay). Of course, WeeChat can do both but ZNC is multi-user.


/set logger.level.irc 0
/set logger.file.path /home/launch/.znc/users/r3m/moddata/log
/set logger.mask.irc %Y/$server/$channel.%m-%d.log

Note: I do not log IRC conversation via WeeChat (I log via ZNC). However, I use the script and this script check the value of logger.file.path. If the module is not loaded, the value is not accessible. You could load logger, then set the correct path and run /logs to build the index and then disable logger but I had an issue when I upgrade WeeChat.


/script install

/set plugins.var.perl.highmon.alignment "nchannel"

/set plugins.var.python.urlserver.http_hostname "<my vps IP>"
/set plugins.var.python.urlserver.http_port "<port>"
/set plugins.var.python.urlserver.http_allowed_ips "^<my home IP>$"
/set plugins.var.python.urlserver.http_url_prefix xox
/set plugins.var.python.urlserver.msg_ignore_buffers core.weechat,python.grep,irc.BitlBee.#security,irc.BitlBee.#technews,perl.highmon
/set plugins.var.python.urlserver.http_embed_youtube on

/set iset.color.bg_selected 31
/set iset.color.option_selected *white
/set iset.color.type_selected *229
/set iset.color.value_selected *121
/set iset.color.type 229
/set iset.color.value 121

/autosort replacements add ## #
/autosort rules add irc.server.*.&* = 0
/autosort rules add irc.server.*.#* = 1
/autosort rules add irc.server.*.\*status = 2

channels (begin with & and #) will appears right below the server, private message from *status will follow and finally the rest.

/set plugins.var.perl.pushover.blacklist irc.server.*,irc.*.*status
/set plugins.var.perl.pushover.pb_apikey ${}
/set plugins.var.perl.pushover.short_name on
/set plugins.var.perl.pushover.service pushbullet

If you use this script, see the input bar below, I included two items from this script to the input bar.

/bar set vi_line_numbers conditions ${active} && ${} == 0

The vi_line_numbers bar will be only visible in the active window whenever we enter an Ex command (whenever the vi_cmd bar is visible).


exec conky at startup and right now

/set weechat.startup.command_after_plugins "/exec -norc -noln -buffer conky conky"
/exec -norc -noln -buffer conky conky

change the title of the conky window

/autosetbuffer add exec.exec.conky title Conky - the light-weight system monitor

It will change the title of the conky window from Executed commands to Conky - the light-weight system monitor

this trigger will beautify the output of conky

/trigger add conky_tag_color modifier weechat_print
/trigger set conky_tag_color conditions ${tg_buffer} == exec.exec.conky
/trigger set conky_tag_color regex /\t(Uptime|CPU|RAM|Swap|Networking|Up|Down):(.*)/${color:_31}${re:1}\t${color:reset}${re:2}/ /No swap/0/

my .conkyrc

background no
cpu_avg_samples 2
net_avg_samples 2
no_buffers yes
out_to_stderr no
update_interval 1.0
uppercase no
use_spacer none

Uptime: $uptime
CPU: $cpu%
RAM: $memperc%
Swap: $swapperc%
Up: ${upspeed venet0}
Down: ${downspeed venet0}

Note: you need conky-cli package on Debian, same for Arch Linux

Weather with

/set fr
/trigger add weather command weather
/trigger set weather regex "/\s/_/tg_argv_eol1"
/trigger set weather command "/exec -noflush -norc -noln -buffer weather curl -s${tg_argv_eol1}?lang=${}"

I found something very similar on the alias wiki page of WeeChat on GitHub. I adjust it for my own use. So when you type /weather Montreal, a new buffer will be created and will show the output of curl -s (I created a trigger instead of an alias to replace space by _ in city name)

/trigger add set_title_weather_buffer print ""
/trigger set set_title_weather_buffer conditions "${buffer.full_name} == && ${tg_message_nocolor} !~ ^\W && ${tg_message_nocolor} !~ (wttr\.in|@igor_chubin)"
/trigger set set_title_weather_buffer command "/command -buffer core /buffer set title ${tg_message_nocolor}"

I created this trigger to change the title of the buffer from Executed commands to Weather for City: Montreal, Canada.

/trigger add weather_shortcut modifier input_text_for_buffer
/trigger set weather_shortcut conditions "${buffer[tg_modifier_data].full_name} == && ${tg_string_nocolor} !~ ^/"
/trigger set weather_shortcut regex "==(.*)==/weather ${re:1}"

This trigger will allow you to enter only the city name (without /weather) in the weather buffer.


Bar buffers

unmerge servers buffers from core and indent

/set irc.look.server_buffer independent

Note: show channels and privates buffers under their respective server instead of mixing them all.

/set buflist.format.buffer "${if:${type}==server?${color:black,31}:${color:239}}${format_number}${indent}${color_hotlist}${name}"
/set buflist.format.buffer_current "${if:${type}==server?${color:*white,31}:${color:*white}}>> ${indent}${color_hotlist}${name}"
/set buflist.format.hotlist_highlight "${color:163}"
/set buflist.format.hotlist_message "${color:229}"
/set buflist.format.hotlist_private "${color:121}"
/set buflist.format.number "${number}${if:${number_displayed}?.: }"
/set 14

Bar active title

/bar add activetitle window top 1 0 buffer_title
/set 500
/set "${active}"
/set white
/set 31
/set on

Note: This bar will be different from the already created one. I set the conditions to ${active} so this bar will be displayed on the active window only. The other one will be used for other windows.

Bar title

/set "${inactive}"
/set black
/set 31

Bar status

/bar add rootstatus root bottom 1 0 [time],[buffer_count],[buffer_plugin],buffer_number+:+buffer_name+(buffer_modes)+{buffer_nicklist_count}+buffer_filter,[bitlbee_typing_notice],[lag],[aspell_dict],[aspell_suggest],[hotlist],completion,scroll
/set 31
/set 234
/set on
/set 500
/bar del status
/bar set rootstatus name status

Note: the built-in status bar is of type window. I prefer a status bar of type root which means it will be outside any window. At this time, you can't change the type of a bar. So we delete the status bar and create a new one.

Bar input

/bar add rootinput root bottom 1 0 [mode_indicator]+[buffer_name]+[input_prompt]+(away),[input_search],[input_paste],input_text,[vi_buffer]"
/set black
/set 1000
/bar del input
/bar set rootinput name input

Note: the built-in input bar is of type window. I prefer a input bar of type root which means it will be outside any window. At this time, you can't change the type of a bar. So we delete the status bar and create a new one.

Bar Nicklist

/set 229
/set on
/set "${nicklist} && ${window.number} == 1"
/set 14
/set 14

Note: I changed the conditions to display the nicklist only on buffer of type channels ${nicklist} and on the window number 1, which is my chat window (2 being my highlight window and 3 my conky window). In my case, I could remove ${window.numer} == 1 because the highmon and exec buffer (conky) are not of type channels so ${nicklist} is enough.

Bar ZNC (see this dedicated gist)

/set plugins.var.python.text_item.znc_commands "private "

/bar add znc_commands window right 14 1 znc_commands
/set "${buffer.full_name} =~ \.*status$ && ${window.number} == 1"
/set 14

/trigger add hsignal_znc_commands hsignal znc_commands
/trigger set hsignal_znc_commands command "/command -buffer ${buffer.full_name} * /quote znc help ${_bar_item_line};/command -buffer ${buffer.full_name} * /input delete_line;/command -buffer ${buffer.full_name} * /input insert ${_bar_item_line}\x20"

/trigger add znc_create_commands_list_and_regex print ""
/trigger set znc_create_commands_list_and_regex conditions "${buffer.short_name} == *status && ${tg_message_nocolor} =~ ^(Command:|\|) [a-zA-Z]+\s && ${tg_message_nocolor} !~ ^\S+ Command\s"
/trigger set znc_create_commands_list_and_regex regex "/^(Command:|\|) ([a-zA-Z]+).*/${re:2}/tg_message_nocolor /.*/${tg_message_nocolor}/tg_message /([^s])s$/${re:1}/tg_message /(?-i).*([A-Z][a-z]+)$/${color:${info:irc_nick_color_name,${re:1}}}${tg_message_nocolor}${color:reset}/tg_message"
/trigger set znc_create_commands_list_and_regex command "/mute set plugins.var.python.text_item.znc_commands ${plugins.var.python.text_item.znc_commands}${tg_message}\${\n};/perlexec my $number = split(/ /, q(${trigger.trigger.hsignal_znc_commands.regex}))\; weechat::command(q(), q(/mute trigger set hsignal_znc_commands regex ${trigger.trigger.hsignal_znc_commands.regex} /^) . $number . q($/${tg_message_nocolor}/_bar_item_line))"

/key bindctxt mouse @item(znc_commands):button1 hsignal:znc_commands  

/set irc.server.freenode.anti_flood_prio_high 0
/perlexec foreach ('a'..'z') { weechat::command(q(), qq(/msg -server freenode *status help $_)) }
/set irc.server.freenode.anti_flood_prio_high 2

wait for "No matches for 'z'" before disabling the trigger and clicking on a command in the bar

/trigger disable znc_create_commands_list_and_regex

This bar will be exactly like a default nicklist bar. That is, right-positionned with vertical filling. But instead of nicknames, it will contains a znc command per line. If you click on a command, the input bar will be filled with the command name, then you add whatever you want or simply press enter. Futhermore, this will send help command to znc.

now the hard part to explain. We need to bind the left mouse button to a hsignal. The hsignal will receive the line number whenever you click on a line in the bar. This hsignal will get the corresponding command name for this line number. But that's not all, we need to create a trigger to fill the bar item with the znc commands and create the appropriate regex for the hsignal. This trigger need to be disabled (or deleted) after all znc commands are in the bar.


Layout highlight

/perlexec my $total = weechat::hdata_integer(weechat::hdata_get("window"), weechat::current_window(), "win_height"); weechat::command($buffer, "/window splith " . int(8 / $total * 100));
/buffer perl.highmon
/window 1
/layout store highlight

Note: Instead of having only one window, we split it to create another one that we will use to show all highlights.

Layout highlight-conky

/window 2
/window splitv 85
/buffer exec.conky
/window 1
/layout store highlight-conky

Note: split the highlight monitor window in 2 and show conky in the new one


/filter add rss irc.freenode.##news irc_privmsg !^\[(/r/netsec|XKCD|Ars Technica|Wired|Wikinews|freenode|EFF|erry|techdirt|TorrentFreak|Science Daily)
/trigger add redirect_newsbin_to_news modifier weechat_print
/trigger set redirect_newsbin_to_news conditions "${tg_buffer} == irc.freenode.#newsbin && ${tg_tag_nick} == slack3r"
/trigger set redirect_newsbin_to_news regex "/.*//"
/trigger set redirect_newsbin_to_news command "/print -buffer irc.freenode.##news ${tg_prefix}\t${tg_message}"
/autosetbuffer add irc.freenode.#newsbin hidden 1

##news and #newsbin are two channels dedicated to live news. On ##news, I use a filter to hide news from site other than those I explicitly mention. On #newsbin, I do not create any filter. Then, the trigger will redirect message from #newsbin to ##news. This way I can see all the news on one buffer. Finally, we hide #newsbin buffer in the buffers bar.


/alias add ptpburl /exec -sh -hsignal ptpburl $* 2>&1 | curl -sF c=@-
/trigger add ptpburl hsignal ptpburl
/trigger set ptpburl command "/command -buffer ${buffer.full_name} core /input delete_line;/command -buffer ${buffer.full_name} core /input insert ${out}"

This allow you to type /ptpburl uptime for example, to send the output of the uptime command to ptpb. Your input bar content will be replaced by the url of the paste. This way you can visit the URL to see if there is sensitive information before giving the url to everyone. You may wonder why I didn't used something like: /exec -sh -pipe "/input delete_line;/input insert " $* 2>&1 | curl -sF c=@- Well If we use this, the input bar will be filled with the command and not the url.

Auto hide channels after inactivity and reattach on activity

/trigger addoff buf_activity_unhide print "" 
/trigger set buf_activity_unhide conditions "${buffer.hidden} == 1 && ${tg_tag_notify} == message"
/trigger set buf_activity_unhide command "/command -buffer irc.$server.$channel core /buffer unhide"

/trigger addoff buf_inactivity_hide timer 10000;0;0
/trigger set buf_inactivity_hide command "/allchan -exclude=#weechat* /eval /perlexec weechat::command('', '/command -buffer irc.\${server}.\${channel} core /buffer hide') if ((${date:%s} - \${buffer[\${info:irc_buffer,\${server},\${channel}}]}) > 300)"

/alias add toggle_auto_hide /trigger toggle buf_activity_unhide buf_inactivity_hide


/set weechat.look.highlight *pascalpoitras*
/autosetbuffer add irc.bitlbee.#twitter_pascalpoitras* highlight_words freenode,snoonet,*weechat*
/autosetbuffer add irc.bitlbee.#LET highlight_regex .*
/autosetbuffer add irc.bitlbee.#deals highlight_regex .*
/autosetbuffer add irc.freenode.##reddit-hockey highlight_regex (^GOAL: MTL.*|^Le But: MTL.*)


/trigger add upgrade_scripts signal day_changed
/trigger set upgrade_scripts command "/script update;/wait 10s /script upgrade"
/trigger add send_to_active_grep_log_nick command send_to_active_grep_log_nick
/trigger set send_to_active_grep_log_nick conditions ${tg_argv_eol1} && ${type} =~ ^(private|channel)$
/trigger set send_to_active_grep_log_nick regex /\\\$/\\\\/tg_argv1
/trigger set send_to_active_grep_log_nick command /input delete_line;/input insert /exec -sh -norc -pipe "/input insert grep -hiP '^\[\d{2}:\d{2}:\d{2}\] (<|\* )\Q${tg_argv1}\E>? ${tg_argv_eol2} " grep -hiP '^\[\d{2}:\d{2}:\d{2}\] (<|\* )\Q${tg_argv1}\E>? ${tg_argv_eol2}' ~/.znc/users/r3m/moddata/log/`date "+%Y"`/'${server}'/'${buffer.short_name}'.* | shuf -n 1

The trigger upgrade_scripts will update the local script cache and then upgrade all the installed scripts at midnight. The send_to_active_grep_log_nick will search in log for something a user said before. Then it will send the output to IRC. I use the when searching in log for myself but I created this trigger to return a random line from a user.


/key bindctxt cursor @item(buffer_nicklist):v /window ${_window_number};/voice ${nick}
/key bindctxt cursor @item(buffer_nicklist):o /window ${_window_number};/op ${nick}
/key bindctxt cursor @item(buffer_nicklist):V /window ${_window_number};/devoice ${nick}
/key bindctxt cursor @item(buffer_nicklist):O /window ${_window_number};/deop ${nick}
/key bindctxt cursor @chat(*):s /window ${_window_number};/slap ${_chat_line_nick};/cursor stop
/key bindctxt cursor @item(buffer_nicklist):s /window ${_window_number};/slap ${nick};/cursor stop
/key bindctxt cursor @item(buflist):d /command -buffer ${full_name} irc /quote znc detach ${short_name};/cursor stop
/key bindctxt cursor @item(buflist):h /command -buffer ${full_name} irc /allchan -current buffer hide;/command -buffer ${full_name} irc /allpv -current buffer hide;/cursor stop
/key bindctxt cursor @item(buflist):H /command -buffer ${full_name} irc /allchan -current buffer unhide;/command -buffer ${full_name} irc /allpv -current buffer unhide;/cursor stop
/key bindctxt cursor @chat(*):g /window ${_window_number};/customgrep ${_chat_line_nick};/cursor stop
/key bindctxt cursor @item(buffer_nicklist):g /window ${_window_number};/customgrep ${nick};/cursor stop
/key bindctxt cursor @chat(*):G /window ${_window_number};/input delete_line;/input insert /send_to_active_grep_log_nick ${_chat_line_nick}\x20;/cursor stop
/key bindctxt cursor @item(buffer_nicklist):G /window ${_window_number};/input delete_line;/input insert /send_to_active_grep_log_nick ${nick}\x20;/cursor stop

I use /buffer hide when I want to hide a buffer in the buffers bar but still want to be able to access it. I use /znc detach on all channels that I have joined only for logging the discussion.

Others Keyboard shortcuts

/key bind meta-meta2-A /bar scroll nicklist * -100%
/key bind meta-meta2-B /bar scroll nicklist * +100%
/key bind meta2-A /input history_global_previous
/key bind meta2-B /input history_global_next


/alias add cq allpv /buffer close
/alias add slap /me slaps $1 around a bit with a large trout
/alias add customgrep /input delete_line;/input insert /grep log */$server/$channel.* -a ^\[\d{2}:\d{2}:\d{2}\] <%{escape $1}>\x20
/alias add znc /quote znc


/set irc.look.smart_filter on
/filter add irc_smart *,!irc.undernet.* irc_smart_filter *

Custom join color

/set weechat.color.chat_prefix_join 121
/set weechat.color.chat_host 31
/set irc.color.message_join 121

The weechat.color.chat_host option will also set this color for part and quit. To have a different color, for example, a host in red for parts and quits and green for joins, see this.

Custom part and quit

/set weechat.color.chat_prefix_quit 131
/set irc.color.message_quit 131

The remaining IRC options

/set irc.server_default.away_check 5
/set irc.server_default.away_check_max_nicks 25
/set irc.color.nick_prefixes "q:lightred;a:lightcyan;o:121;h:lightmagenta;v:229;*:lightblue"
/set "*!*@$host"
/set irc.look.buffer_switch_autojoin off
/set irc.look.buffer_switch_join off
/set irc.look.color_nicks_in_nicklist on
/set irc.look.part_closes_buffer on

The remaining Weechat options

/set weechat.look.bar_more_down "▼"
/set weechat.look.bar_more_left "◀"
/set weechat.look.bar_more_right "▶"
/set weechat.look.bar_more_up "▲"
/set weechat.look.buffer_time_format "${253}%H${245}%M"
/set weechat.look.color_inactive_message off
/set weechat.look.color_inactive_prefix off
/set weechat.look.color_inactive_prefix_buffer off
/set weechat.look.color_inactive_window off
/set weechat.look.day_change_message_1date ▬▬▶ %a, %d %b %Y ◀▬▬
/set weechat.look.day_change_message_2dates ▬▬▶ %%a, %%d %%b %%Y (%a, %d %b %Y) ◀▬▬
/set weechat.look.hotlist_count_max 0
/set weechat.look.hotlist_names_count 10
/set weechat.look.item_buffer_filter "•"
/set weechat.look.prefix_align_min 0
/set weechat.look.prefix_align_max 10
/set weechat.look.prefix_join "▬▬▶"
/set weechat.look.prefix_quit "◀▬▬"
/set weechat.look.prefix_suffix "│"
/set weechat.look.read_marker_string "─"
/set weechat.look.separator_horizontal "="

/set weechat.color.bar_more 229
/set weechat.color.chat_highlight lightred
/set weechat.color.chat_highlight_bg default
/set weechat.color.chat_nick_colors 25,31,37,43,49,61,67,73,79,85,97,103,109,115,121,133,139,145,151,157,163,169,175,181,187,193,199,205,211,217,223,229
/set weechat.color.chat_prefix_more 229
/set weechat.color.chat_prefix_suffix 31
/set weechat.color.chat_read_marker 31
/set weechat.color.chat_time 239
/set weechat.color.chat_delimiters 31
/set weechat.color.separator 31
/set weechat.color.status_data_highlight 163
/set weechat.color.status_data_msg 229
/set weechat.color.status_data_private 121
/set weechat.color.status_more 229
/set weechat.color.status_name 121
/set weechat.color.status_name_ssl 121
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment