You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
eta 70685f40c0 xmpp: NIH a whole promises library (!), use it for disco#info 1 year ago
.github core: switch to PHP 8.0 in CI 2 years ago
cmake xmpp: add Common Lisp support library & integrate with cmake 1 year ago
debian-devel debian: add Spanish FAQ in Debian packaging 2 years ago
debian-stable debian: add Spanish FAQ in Debian packaging 2 years ago
doc irc: add option "-parted" in command /allchan (closes #1685) 2 years ago
icons core: update copyright dates 2 years ago
po core: update German translations 2 years ago
src xmpp: NIH a whole promises library (!), use it for disco#info 1 year ago
tests irc: save CLIENTTAGDENY from message 005 in server, do not send typing messages if "typing" client tag is denied 2 years ago
tools core: do not force build of JavaScript plugin in CI 2 years ago
.gitattributes core: remove obsolete directory from .gitattributes 4 years ago
.gitignore core: update build directories in .gitignore 3 years ago
.mailmap Restore e-mail already used in commits 5 years ago
.travis.yml core: add CI with GitHub Actions, move upload to GitHub Actions 3 years ago
AUTHORS.adoc core: add contributor (issue #1656) 2 years ago
CMakeLists.txt xmpp: initialize stub plugin 2 years ago
COPYING core: use https for links to GNU GPL license 4 years ago
ChangeLog.adoc irc: add option "-parted" in command /allchan (closes #1685) 2 years ago
Contributing.adoc doc: replace freenode by libera in contributing guide 2 years ago core: update copyright dates 2 years ago
README.adoc core: update copyright dates 2 years ago
ReleaseNotes.adoc core: add bar item "typing" in status bar by default 2 years ago core: update copyright dates 2 years ago
config.h.cmake core: improve options to load GnuTLS system/user CAs (closes #972) 2 years ago php: fix PHP 8+ build 2 years ago Version 3.3-dev 2 years ago build: add typing plugin in Cygwin packaging 2 years ago
weechat.desktop core: add German translations in weechat.desktop 3 years ago core: fix typo: Weechat -> WeeChat 4 years ago
weechat.spec Version 3.2 2 years ago


:author: Sébastien Helleu
:lang: en

pass:[<p align="center">] image:[align="center"] pass:[</p>]

image:*-follow-blue.svg["Diaspora*", link=""]
image:["Mastodon", link=""]
image:["Twitter", link=""]
image:["Devel blog", link=""]
image:["Slant", link=""]
image:["Donate", link=""]

image:["CI", link=""]
image:["Code coverage", link=""]

*WeeChat* (Wee Enhanced Environment for Chat) is a free chat client, fast and
light, designed for many operating systems.
It is highly customizable and extensible with scripts.


== Features

* *Modular chat client*: WeeChat has a lightweight core and optional[plugins]. All plugins (including[IRC]) are independent and can be unloaded.
* *Multi-platform*: WeeChat runs on GNU/Linux, *BSD, GNU/Hurd, Haiku, macOS and Windows (Bash/Ubuntu and Cygwin).
* *Multi-protocols*: WeeChat is designed to support multiple protocols by plugins, like IRC.
* *Standards-compliant*: the IRC plugin is compliant with RFCs[1459],[2810],[2811],[2812] and[2813].
* *Small, fast and very light*: the core is and should stay as light and fast as possible.
* *Customizable and extensible*: there are a lot of options to customize WeeChat, and it is extensible with C plugins and[scripts] ([Perl],[Python],[Ruby],[Lua],[Tcl],[Scheme],[JavaScript] and[PHP]).
* *Fully documented*: there is comprehensive[documentation], which is[translated] into several languages.
* *Developed from scratch*: WeeChat was built from scratch and is not based on any other client.
* *Free software*: WeeChat is released under[GPLv3].

pass:[<p align="center">] image:[align="center"] pass:[</p>]

On WeeChat's website you can find[more screenshots].

== Install

=== Dependencies

Following packages are *required*:

* CMake
* libncurses
* libcurl
* zlib
* libgcrypt

Following packages are optional:

* for i18n: gettext
* for SSL: gnutls, ca-certificates
* for spell checking: aspell or enchant
* for scripting: python, perl, ruby, lua, tcl, guile, libv8 (javascript), php
* for building doc and man page: asciidoctor
* for building tests: C++ compiler, CppUTest

For a complete list of dependencies and versions recommended, please look at[user's guide].

=== Compile

WeeChat can be built with[CMake] (recommended) or autotools.

Only CMake is officially supported to build WeeChat. You should only use
autotools if you are not able to use CMake. +
Building with autotools requires more dependencies and is slower than with CMake.

* Installation in system directories (requires _root_ privileges):

$ mkdir build
$ cd build
$ cmake ..
$ make
$ sudo make install

* Installation in custom directory (for example your home):

$ mkdir build
$ cd build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/directory
$ make
$ make install

For more information or installation with autotools, please look at[user's guide].

=== Run tests

Following packages are *required* to compile tests:

* libcpputest-dev
* C++ compiler

Tests must be enabled when compiling WeeChat:

$ cmake .. -DENABLE_TESTS=ON

They can be launched after compilation from the build directory:

$ ctest -V

== Copyright

Copyright (C) 2003-2021 Sébastien Helleu <>

This file is part of WeeChat, the extensible chat client.

WeeChat is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.

WeeChat is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with WeeChat. If not, see <>.