This manual documents WeeChat chat client, it is part of WeeChat.

Latest version of this document can be found on this page:


WeeChat (Wee Enhanced Environment for Chat) is a free chat client, fast and light, designed for many operating systems.

This manual documents way to write scripts for WeeChat, using one of supported script languages:

  • python

  • perl

  • ruby

  • lua

  • tcl

  • guile (scheme)

  • javascript

Almost all examples in this doc are written in Python, but API is the same for other languages.

Scripts in WeeChat

Languages specificities


  • You have to import weechat

  • Functions print* are called prnt* in python (because print is reserved keyword)

  • Functions are called with, arg2, ...)


  • Functions are called with weechat::xxx(arg1, arg2, ...);


  • You have to define weechat_init and call register inside

  • Functions are called with, arg2, ...)

  • Due to a limitation of Ruby (15 arguments max by function), the function Weechat.config_new_option receives the callbacks in an array of 6 strings (3 callbacks + 3 data strings), so a call to this function looks like:

Weechat.config_new_option(config, section, "name", "string", "description of option", "", 0, 0,
                          "value", "value", 0, ["check_cb", "", "change_cb", "", "delete_cb", ""])


  • Functions are called with, arg2, ...)


  • Functions are called with weechat::xxx arg1 arg2 ...

Guile (scheme)

  • Functions are called with (weechat:xxx arg1 arg2 ...)

  • Following functions take one list of arguments (instead of many arguments for other functions), because number of arguments exceed number of allowed arguments in Guile:

    • config_new_section

    • config_new_option

    • bar_new


  • Functions are called with, arg2, ...);

Register function

All WeeChat scripts must "register" themselves to WeeChat, and this must be first WeeChat function called in script.


weechat.register(name, author, version, license, description, shutdown_function, charset)


  • name: string, internal name of script

  • author: string, author name

  • version: string, script version

  • license: string, script license

  • description: string, short description of script

  • shutdown_function: string, name of function called when script is unloaded (can be empty string)

  • charset: string, script charset (if your script is UTF-8, you can use blank value here, because UTF-8 is default charset)

Example of script, for each language:

  • Python:

import weechat

weechat.register("test_python", "FlashCode", "1.0", "GPL3", "Test script", "", "")
weechat.prnt("", "Hello, from python script!")
  • Perl:

weechat::register("test_perl", "FlashCode", "1.0", "GPL3", "Test script", "", "");
weechat::print("", "Hello, from perl script!");
  • Ruby:

def weechat_init
  Weechat.register("test_ruby", "FlashCode", "1.0", "GPL3", "Test script", "", "")
  Weechat.print("", "Hello, from ruby script!")
  return Weechat::WEECHAT_RC_OK
  • Lua:

weechat.register("test_lua", "FlashCode", "1.0", "GPL3", "Test script", "", "")
weechat.print("", "Hello, from lua script!")
  • Tcl:

weechat::register "test_tcl" "FlashCode" "1.0" "GPL3" "Test script" "" ""
weechat::print "" "Hello, from tcl script!"
  • Guile (scheme):

(weechat:register "test_scheme" "FlashCode" "1.0" "GPL3" "Test script" "" "")
(weechat:print "" "Hello, from scheme script!")
  • Javascript:

weechat.register("test_js", "FlashCode", "1.0", "GPL3", "Test script", "", "");
weechat.print("", "Hello, from javascript script!");

Load script

It is recommended to use the "script" plugin to load scripts, for example:

/script load
/script load
/script load script.rb
/script load script.lua
/script load script.tcl
/script load script.scm
/script load script.js

Each language has also its own command:

/python load
/perl load
/ruby load script.rb
/lua load script.lua
/tcl load script.tcl
/guile load script.scm
/javascript load script.js

You can make link in directory language/autoload to autoload script when WeeChat is starting.

For example with Python:

$ cd ~/.weechat/python/autoload
$ ln -s ../
When installing a script with command /script install the link in autoload directory is automatically created.

Differences with C API

Script API is almost the same as C plugin API. You can look at WeeChat Plugin API Reference for detail about each function in API: prototype, arguments, return values, examples.

It’s important to make difference between a plugin and a script: a plugin is a binary file compiled and loaded with command /plugin, whereas a script is a text file loaded with a plugin like python with command /python.

When your script calls a WeeChat API function, path is like that:

               ┌──────────────────────┐        ╔══════════════════╗
               │     python plugin    │        ║  WeeChat "core"  ║
               ├────────────┬─────────┤        ╟─────────┐        ║ ─────► │ script API │  C API  │ ─────► ║  C API  │        ║
               └────────────┴─────────┘        ╚═════════╧════════╝

When WeeChat calls a callback in your script, it’s reverse of previous path:

╔══════════════════╗        ┌──────────────────────┐
║  WeeChat "core"  ║        │     python plugin    │
║        ┌─────────╢        ├─────────┬────────────┤
║        │  C API  ║ ─────► │  C API  │ script API │ ─────►
╚════════╧═════════╝        └─────────┴────────────┘


As you probably know, there is not really "pointers" in scripts. So when API functions return pointer, it is converted to string for script.

For example, if function return pointer 0x1234ab56, script will get string "0x1234ab56".

And when an API function expects a pointer in arguments, script must give that string value. C plugin will convert it to real pointer before calling C API function.

Empty string or "0x0" are allowed, they means NULL in C. For example, to print data on core buffer (WeeChat main buffer), you can do:

weechat.prnt("", "hi!")
In many functions, for speed reasons, WeeChat does not check if your pointer is correct or not. It’s your job to check you’re giving a valid pointer, otherwise you may see a nice crash report ;)


Almost all WeeChat callbacks must return WEECHAT_RC_OK or WEECHAT_RC_ERROR (exception is modifier callback, which returns a string).

C callbacks are using a "data" argument, which is a pointer. In script API, this "data" is a string with a any value (it’s not a pointer).

Example of callback, for each language:

  • Python:

def timer_cb(data, remaining_calls):
    weechat.prnt("", "timer! data=%s" % data)
    return weechat.WEECHAT_RC_OK

weechat.hook_timer(1000, 0, 1, "timer_cb", "test")
  • Perl:

sub timer_cb {
    my ($data, $remaining_calls) = @_;
    weechat::print("", "timer! data=$data");
    return weechat::WEECHAT_RC_OK;

weechat::hook_timer(1000, 0, 1, "timer_cb", "test");
  • Ruby:

def timer_cb(data, remaining_calls)
  Weechat.print("", "timer! data=#{data}");
  return Weechat::WEECHAT_RC_OK

Weechat.hook_timer(1000, 0, 1, "timer_cb", "test");
  • Lua:

function timer_cb(data, remaining_calls)
    weechat.print("", "timer! data="
    return weechat.WEECHAT_RC_OK

weechat.hook_timer(1000, 0, 1, "timer_cb", "test")
  • Tcl:

proc timer_cb { data remaining_calls } {
    weechat::print {} "timer! data=$data"
    return $::weechat::WEECHAT_RC_OK

weechat::hook_timer 1000 0 1 timer_cb test
  • Guile (scheme):

(define (timer_cb data remaining_calls)
  (weechat:print "" (string-append "timer! data=" data))

(weechat:hook_timer 1000 0 1 "timer_cb" "test")
  • Javascript:

function timer_cb(data, remaining_calls) {
    weechat.print("", "timer! data=" + data);
    return weechat.WEECHAT_RC_OK;

weechat.hook_timer(1000, 0, 1, "timer_cb", "test");

Script API

For more information about functions in API, please read WeeChat Plugin API Reference.


List of functions in script API:

Category Functions






charset_set, iconv_to_internal, iconv_from_internal, gettext, ngettext,
strlen_screen, string_match, string_has_highlight, string_has_highlight_regex, string_mask_to_regex, string_remove_color, string_is_command_char, string_input_for_buffer, string_eval_expression


mkdir_home, mkdir, mkdir_parents

sorted lists

list_new, list_add, list_search, list_search_pos, list_casesearch, list_casesearch_pos, list_get, list_set, list_next, list_prev, list_string, list_size, list_remove, list_remove_all, list_free

configuration files

config_new, config_new_section, config_search_section, config_new_option, config_search_option,
config_string_to_boolean, config_option_reset, config_option_set, config_option_set_null, config_option_unset, config_option_rename, config_option_is_null, config_option_default_is_null,
config_boolean, config_boolean_default, config_integer, config_integer_default, config_string, config_string_default, config_color, config_color_default,
config_write_option, config_write_line, config_write, config_read, config_reload,
config_option_free, config_section_free_options, config_section_free, config_free,
config_get, config_get_plugin, config_is_set_plugin, config_set_plugin, config_set_desc_plugin, config_unset_plugin

key bindings

key_bind, key_unbind


prefix, color, print (for python: prnt), print_date_tags (for python: prnt_date_tags), print_y (for python: prnt_y), log_print


hook_command, hook_command_run, hook_timer, hook_fd, hook_process, hook_process_hashtable, hook_connect, hook_print, hook_signal, hook_signal_send, hook_hsignal, hook_hsignal_send, hook_config, hook_completion, hook_completion_list_add, hook_modifier, hook_modifier_exec, hook_info, hook_info_hashtable, hook_infolist, hook_focus, hook_set, unhook, unhook_all


buffer_new, current_buffer, buffer_search, buffer_search_main, buffer_clear, buffer_close, buffer_merge, buffer_unmerge, buffer_get_integer, buffer_get_string, buffer_get_pointer, buffer_set, buffer_string_replace_local_var, buffer_match_list


current_window, window_search_with_buffer, window_get_integer, window_get_string, window_get_pointer, window_set_title


nicklist_add_group, nicklist_search_group, nicklist_add_nick, nicklist_search_nick, nicklist_remove_group, nicklist_remove_nick, nicklist_remove_all, nicklist_group_get_integer, nicklist_group_get_string, nicklist_group_get_pointer, nicklist_group_set, nicklist_nick_get_integer, nicklist_nick_get_string, nicklist_nick_get_pointer, nicklist_nick_set


bar_item_search, bar_item_new, bar_item_update, bar_item_remove, bar_search, bar_new, bar_set, bar_update, bar_remove




info_get, info_get_hashtable


infolist_new, infolist_new_item, infolist_new_var_integer, infolist_new_var_string, infolist_new_var_pointer, infolist_new_var_time,
infolist_get, infolist_next, infolist_prev, infolist_reset_item_cursor,
infolist_fields, infolist_integer, infolist_string, infolist_pointer,
infolist_time, infolist_free


hdata_get, hdata_get_var_offset, hdata_get_var_type_string, hdata_get_var_array_size, hdata_get_var_array_size_string, hdata_get_var_hdata, hdata_get_list, hdata_check_pointer, hdata_move, hdata_search, hdata_char, hdata_integer, hdata_long, hdata_string, hdata_pointer, hdata_time, hdata_hashtable, hdata_update, hdata_get_string


upgrade_new, upgrade_write_object, upgrade_read, upgrade_close


List of constants in script API:

Category Constants

return codes


configuration files


sorted lists




hook process


hook connect


hook signal


Common tasks

This chapter shows some common tasks, with examples. Only partial things in API are used here, for full reference, see WeeChat Plugin API Reference.


Display messages

An empty string is often used to work with WeeChat core buffer. For other buffers, you must give pointer (as string, see pointers).


# display "hello" on core buffer
weechat.prnt("", "hello")

# display "hello" on core buffer, but do not write it to log file
# (version >= 0.3.3 only)
weechat.prnt_date_tags("", 0, "no_log", "hello")

# display prefix "==>" and message "hello" on current buffer
# (prefix and message must be separated by tab)
weechat.prnt(weechat.current_buffer(), "==>\thello")

# display error message on core buffer (with error prefix)
weechat.prnt("", "%swrong arguments" % weechat.prefix("error"))

# display message with color on core buffer
weechat.prnt("", "text %syellow on blue" % weechat.color("yellow,blue"))

# search buffer and display message
# (full name of buffer is, for example: "irc.freenode.#weechat")
buffer = weechat.buffer_search("irc", "freenode.#weechat")
weechat.prnt(buffer, "message on #weechat channel")

# other solution to find an IRC buffer (better)
# (note that server and channel are separated by a comma)
buffer = weechat.info_get("irc_buffer", "freenode,#weechat")
weechat.prnt(buffer, "message on #weechat channel")
Print function is called print in Perl/Ruby/Lua/Tcl/Guile/Javascript and prnt in Python.

Send text to buffer

You can send text or command to a buffer. This is exactly like if you type text on command line and press [Enter].


# execute command "/help" on current buffer (result is on core buffer)
weechat.command("", "/help")

# send "hello" to #weechat IRC channel (users on channel will see message)
buffer = weechat.info_get("irc_buffer", "freenode,#weechat")
weechat.command(buffer, "hello")

Create new buffer

You can create a new buffer in your script, then use it for displaying messages.

Two callbacks can be called (they are optional): one for input data (when you type some text and press [Enter] on buffer), the other is called when buffer is closed (for example by /buffer close).


# callback for data received in input
def buffer_input_cb(data, buffer, input_data):
    # ...
    return weechat.WEECHAT_RC_OK

# callback called when buffer is closed
def buffer_close_cb(data, buffer):
    # ...
    return weechat.WEECHAT_RC_OK

# create buffer
buffer = weechat.buffer_new("mybuffer", "buffer_input_cb", "", "buffer_close_cb", "")

# set title
weechat.buffer_set(buffer, "title", "This is title for my buffer.")

# disable logging, by setting local variable "no_log" to "1"
weechat.buffer_set(buffer, "localvar_set_no_log", "1")

Buffer properties

You can read buffer properties, as string, integer or pointer.


buffer = weechat.current_buffer()

number = weechat.buffer_get_integer(buffer, "number")
name = weechat.buffer_get_string(buffer, "name")
short_name = weechat.buffer_get_string(buffer, "short_name")

It is possible to add, read or delete local variables in buffer:

# add local variable
weechat.buffer_set(buffer, "localvar_set_myvar", "my_value")

# read local variable
myvar = weechat.buffer_get_string(buffer, "localvar_myvar")

# delete local variable
weechat.buffer_set(buffer, "localvar_del_myvar", "")

To see local variables of a buffer, do this command in WeeChat:

/buffer localvar


Add new command

Add a custom command with hook_command. You can use a custom completion template to complete arguments of your command.


def my_command_cb(data, buffer, args):
    # ...
    return weechat.WEECHAT_RC_OK

hook = weechat.hook_command("myfilter", "description of myfilter",
    "[list] | [enable|disable|toggle [name]] | [add name plugin.buffer tags regex] | [del name|-all]",
    "description of arguments...",
    " || enable %(filters_names)"
    " || disable %(filters_names)"
    " || toggle %(filters_names)"
    " || add %(filters_names) %(buffers_plugins_names)|*"
    " || del %(filters_names)|-all",
    "my_command_cb", "")

And then in WeeChat:

/help myfilter

/myfilter arguments...

Add a timer

Add a timer with hook_timer.


def timer_cb(data, remaining_calls):
    # ...
    return weechat.WEECHAT_RC_OK

# timer called each minute when second is 00
weechat.hook_timer(60 * 1000, 60, 0, "timer_cb", "")

Run a background process

You can run a background process with hook_process. Your callback will be called when data is ready. It may be called many times.

For the last call to your callback, rc is set to 0 or positive value, it’s return code of command.


process_output = ""

def my_process_cb(data, command, rc, out, err):
    global process_output
    if out != "":
        process_output += out
    if int(rc) >= 0:
        weechat.prnt("", process_output)
    return weechat.WEECHAT_RC_OK

weechat.hook_process("/bin/ls -l /etc", 10 * 1000, "my_process_cb", "")

URL transfer

New in version 0.3.7.

To download URL (or post to URL), you have to use function hook_process, or hook_process_hashtable if you need to set options for URL transfer.

Example of URL transfer without option: the HTML page will be received as "out" in callback (standard output of process):

# Display current stable version of WeeChat.
weechat_version = ""

def weechat_process_cb(data, command, rc, out, err):
    global weechat_version
    if out != "":
        weechat_version += out
    if int(rc) >= 0:
        weechat.prnt("", "Current WeeChat stable is: %s" % weechat_version)
    return weechat.WEECHAT_RC_OK

                     30 * 1000, "weechat_process_cb", "")
All infos available about WeeChat are on page

Example of URL transfer with an option: download latest WeeChat development package in file /tmp/weechat-devel.tar.gz:

def my_process_cb(data, command, rc, out, err):
    if int(rc) >= 0:
        weechat.prnt("", "End of transfer (rc=%s)" % rc)
    return weechat.WEECHAT_RC_OK

                               {"file_out": "/tmp/weechat-devel.tar.gz"},
                               30 * 1000, "my_process_cb", "")

For more information about URL transfer and available options, see functions hook_process and hook_process_hashtable in WeeChat Plugin API Reference.

Config / options

Set options for script

Function config_is_set_plugin is used to check if an option is set or not, and config_set_plugin to set option.


script_options = {
    "option1" : "value1",
    "option2" : "value2",
    "option3" : "value3",
for option, default_value in script_options.items():
    if not weechat.config_is_set_plugin(option):
        weechat.config_set_plugin(option, default_value)

Detect changes

You must use hook_config to be notified if user changes some script options.


SCRIPT_NAME = "myscript"

# ...

def config_cb(data, option, value):
    """Callback called when a script option is changed."""
    # for example, read all script options to script variables...
    # ...
    return weechat.WEECHAT_RC_OK

# ...

weechat.hook_config("plugins.var.python." + SCRIPT_NAME + ".*", "config_cb", "")
# for other languages, change "python" with your language (perl/ruby/lua/tcl/guile/javascript)

Read WeeChat options

Function config_get returns pointer to option. Then, depending on option type, you must call config_string, config_boolean, config_integer or config_color.

# string
weechat.prnt("", "value of option weechat.look.item_time_format is: %s"
                 % (weechat.config_string(weechat.config_get("weechat.look.item_time_format"))))

# boolean
weechat.prnt("", "value of option weechat.look.day_change is: %d"
                 % (weechat.config_boolean(weechat.config_get("weechat.look.day_change"))))

# integer
weechat.prnt("", "value of option weechat.look.scroll_page_percent is: %d"
                 % (weechat.config_integer(weechat.config_get("weechat.look.scroll_page_percent"))))

# color
weechat.prnt("", "value of option weechat.color.chat_delimiters is: %s"
                 % (weechat.config_color(weechat.config_get("weechat.color.chat_delimiters"))))


Catch messages

IRC plugin sends two signals for a message received (xxx is IRC internal server name, yyy is IRC command name like JOIN, QUIT, PRIVMSG, 301, ..):


signal sent before processing message


signal sent after processing message

def join_cb(data, signal, signal_data):
    # signal is for example: "freenode,irc_in2_join"
    # signal_data is IRC message, for example: ":nick!user@host JOIN :#channel"
    nick = weechat.info_get("irc_nick_from_host", signal_data)
    server = signal.split(",")[0]
    channel = signal_data.split(":")[-1]
    buffer = weechat.info_get("irc_buffer", "%s,%s" % (server, channel))
    if buffer:
        weechat.prnt(buffer, "Eheh, %s has joined this channel!" % nick)
    return weechat.WEECHAT_RC_OK

# it is useful here to use "*" as server, to catch JOIN messages on all IRC
# servers
weechat.hook_signal("*,irc_in2_join", "join_cb", "")

Modify messages

IRC plugin sends a "modifier" called "irc_in_xxx" ("xxx" is IRC command) for a message received, so that you can modify it.

def modifier_cb(data, modifier, modifier_data, string):
    # add server name to all messages received
    # (OK that's not very useful, but that's just an example!)
    return "%s %s" % (string, modifier_data)

weechat.hook_modifier("irc_in_privmsg", "modifier_cb", "")
A malformed message could crash WeeChat or cause severe problems!

Parse message

New in version 0.3.4.

You can parse an IRC message with info_hashtable called "irc_message_parse".

dict = weechat.info_get_hashtable("irc_message_parse",
                                  {"message": ":nick!user@host PRIVMSG #weechat :message here"})
weechat.prnt("", "dict: %s" % dict)

# output:
#   dict: {'nick': 'nick', 'host': 'nick!user@host', 'command': 'PRIVMSG', 'arguments': '#weechat :message here', 'channel': '#weechat'}


WeeChat version

The best way to check version is to ask "version_number" and make integer comparison with hexadecimal version number.


version = weechat.info_get("version_number", "") or 0
if int(version) >= 0x00030200:
    weechat.prnt("", "This is WeeChat 0.3.2 or newer")
    weechat.prnt("", "This is WeeChat 0.3.1 or older")
Versions ≤ return empty string for info_get("version_number") so you must check that value returned is not empty.

To get version as string:

# this will display for example "Version 0.3.2"
weechat.prnt("", "Version %s" % weechat.info_get("version", ""))

Other infos

# WeeChat home directory, for example: "/home/xxxx/.weechat"
weechat.prnt("", "WeeChat home dir: %s" % weechat.info_get("weechat_dir", ""))

# keyboard inactivity
weechat.prnt("", "Inactivity since %s seconds" % weechat.info_get("inactivity", ""))


Read an infolist

You can read infolist built by WeeChat or other plugins.


# read infolist "buffer", to get list of buffers
infolist = weechat.infolist_get("buffer", "", "")
if infolist:
    while weechat.infolist_next(infolist):
        name = weechat.infolist_string(infolist, "name")
        weechat.prnt("", "buffer: %s" % name)
Don’t forget to call infolist_free to free memory used by infolist, because WeeChat will not automatically free memory.