kiwix /kiwix-tools

Command line Kiwix tools: kiwix-serve, kiwix-manage, ...

★ 996⑂ 155👁 23⑃ 302● 508▤ 9
C++GPL-3.0Created 2016-10-31download.kiwix.org/release/kiwix-tools/
More from this author
Download: 3.8.23.8.2 ↓3.8.22026-03-02
+1
Daily
996
stars
155
forks
23
watchers
302
prs
508
issues
9
releases

README

Kiwix tools
===========

The Kiwix tools is a collection of Kiwix related
command line tools:
 kiwix-manage: Manage XML based library of ZIM files
 kiwix-search: Full text search in ZIM files
 kiwix-serve: HTTP daemon serving ZIM files




![Docker)](https://ghcr.io/kiwix/kiwix-tools)





Disclaimer
----------

This document assumes you have a little knowledge about software
compilation. If you experience difficulties with the dependencies or
with the Kiwix tools compilation itself, we recommend to have a look
to kiwix-build.

Preamble
--------

Although the Kiwix tools can be compiled/cross-compiled on/for many
systems, the following documentation explains how to do it on POSIX
ones. It is primarily thought for GNU/Linux systems and has been tested
on recent releases of
Debian/Ubuntu and
Fedora.

Dependencies
------------

The Kiwix tools rely on a few third party software libraries. They are
prerequisites to the Kiwix tools compilation. Therefore, following
libraries need to be available:
 libkiwix (package libkiwix on Debian/Ubuntu)
 libzim (package libzim on Debian/Ubuntu)

These dependencies may or may not be packaged by your operating
system. They may also be packaged but only in an older version. They
may be also packaged but without providing a static version. The
compilation script will tell you if one of them is missing or too old.
In the worse case, you will have to download and compile bleeding edge
version by hand.

If you want to install these dependencies locally, then use the
kiwix-tools directory as install prefix.

If you want to compile Kiwix tools statically, the dependencies should
be compiled statically (provide a lib...a library), for example by
using --enable-static with ./configure.

Environment
-------------

The Kiwix tools build using Meson version
0.43 or higher. Meson relies itself on Ninja, pkg-config and a few other
compilation tools. Install them first:
 Meson
 Ninja
 pkg-config

These tools should be packaged if you use a cutting edge operating
system. If not, have a look to the Troubleshooting
section.

Compilation
-----------

Once all dependencies are installed, you can compile Kiwix tools with:
bash
meson . build
ninja -C build


By default, it will compile dynamic linked libraries. If you want
statically linked libraries, you can add -Dstatic-linkage=true
option to the Meson command.

Depending of you system, ninja may be called ninja-build.

Installation
------------

If you want to install the Kiwix tools, here we go:
bash
ninja -C build install


You might need to run the command as root (or using sudo),
depending on where you want to install the Kiwix tools. After the
installation succeeded, you may need to run ldconfig (as root).

Uninstallation
------------

If you want to uninstall the Kiwix tools:
bash
ninja -C build uninstall


Like for the installation, you might need to run the command as root
(or using sudo).

Docker
------

An official Docker image of the Kiwix tools can be found on 
GHCR. A
ki

Top issues

Discussions

Latest release

3.8.2 3.8.2 2026-03-02
Other
   - Fix PPA publishing (@kelson42 800)
   - Use windows-2025 CI runner (@kelson42 805)
   - Updated documentation of lang and category filters in catalog query API endpoints (@veloman-yunkan 804)

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON