Skip to content
Back to search

Zimi

The offline internet — searchable, browsable, and self-updating. A modern server for ZIM files with cross-source search, built-in library management, JSON API and MCP server.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/epheterson/Zimi with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/epheterson/Zimi'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/epheterson--zimi/badge.svg)](/listings/epheterson--zimi)

HTML

<a href="/listings/epheterson--zimi"><img src="/api/listings/epheterson--zimi/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

**macOS**

brew tap epheterson/zimi
brew trust --tap epheterson/zimi   # Homebrew 6 and later
brew install --cask zimi

**Linux:** `sudo snap install zimi`, or the [AppImage](https://github.com/epheterson/Zimi/releases) (it updates itself; the window needs WebKitGTK 4.1 from your distro, otherwise Zimi opens in your browser).

**Windows:** the installer or portable zip from [Releases](https://github.com/epheterson/Zimi/releases).

**Docker**

docker run --network host -v ./zims:/zims -v ./zimi-config:/config epheterson/zimi

`/zims` holds your ZIM files, `/config` keeps settings and indexes. Open http://localhost:8899. Host networking lets LAN discovery and seeding work; for bridge mode, Compose, rootless Podman and Kubernetes see [operations](docs/features/operations.md) and [networking](docs/deployment-networking.md).

**Python**

pip install zimi
ZIM_DIR=./zims zimi serve --port 8899

Two packages: `pip install zimi` is the complete experience; `pip install zimi-mcp` is only the [MCP server](#mcp-server) and search, for AI agents (280 KB, no web app).

Most people configure nothing. Everything is in Settings; `zimi config` prints every effective value and where it came from, and each `ZIMI_*` variable is documented in the guides below.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 144 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. # Zimi
  2. [![CI](https://github.com/epheterson/Zimi/actions/workflows/ci.yml/badge.svg)](https://github.com/epheterson/Zimi/actions/workflows/ci.yml)
  3. [![Lighthouse Accessibility](https://img.shields.io/badge/Lighthouse%20a11y-100%2F100-success?logo=lighthouse&logoColor=white)](docs/features/reading.md)
  4. [![WCAG 2.1 AA](https://img.shields.io/badge/WCAG%202.1-AA-blue)](docs/features/reading.md)
  5. [![i18n](https://img.shields.io/badge/i18n-10%20languages-blueviolet)](#languages)
  6. [![Docker Pulls](https://img.shields.io/docker/pulls/epheterson/zimi)](https://hub.docker.com/r/epheterson/zimi)
  7. [![PyPI](https://img.shields.io/pypi/v/zimi)](https://pypi.org/project/zimi/)
  8. [![License: GPL-3.0-or-later](https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg)](LICENSE)
  9. **If you ❤️ Zimi, leave a ⭐️ to help others find it.**
  10. A modern experience for your ZIM files.
  11. [Kiwix](https://kiwix.org) packages the world's knowledge into ZIM files. Zimi makes them feel like the real internet with a rich web UI, fast JSON API, and an MCP server for AI agents. Everything works offline, in your language.
  12. Use as much as you need:
  13. - **Search for agents.** `pip install zimi-mcp` searches and reads every ZIM over MCP. 280 KB.
  14. - **A reader and library.** `ZIMI_APPS=0 zimi serve` reads, searches and manages your ZIMs, nothing more.
  15. - **The whole app.** Everything below.
  16. ## What it does
  17. - **Search everything.** One query across every ZIM, 100M+ articles, with `-word`, `"exact words"`, `OR`, `lang:` and `in:` when you need them.
  18. - **Apps over your library.** Zimipedia for every wiki, the Dictionary for every Wiktionary, Bookshelf for every book, ZimiTube for video, ZimiExchange for Q&A, Reddot for subreddits, and offline street Maps.
  19. - **Games and the Almanac.** Over 100 offline games and a sky reference, both real ZIMs: [download them](https://github.com/epheterson/Zimi/releases/latest) or find them in [`zimi/builtin/`](zimi/builtin/).
  20. - **Keep what you find.** Bookmarks, lists, likes and highlights in every app, synced across devices when you sign in.
  21. - **A real library.** The whole Kiwix catalog one click away, even offline, with auto-updates and BitTorrent downloads that seed back.
  22. - **Make your own ZIMs.** A web page, a whole site, a video playlist, a subreddit, a web archive or a folder of your files.
  23. - **Share on your network.** Zimi devices find each other and pass ZIMs at LAN speed.
  24. - **Every language.** Articles across languages by Wikidata ID; ten UI languages, right-to-left included; offline voices.
  25. - **For people and agents.** Web app, JSON API and an MCP server. Runs on Docker, Podman, pip, macOS, Windows, Linux, or your phone as a PWA.
  26. ## Screenshots
  27. | Homepage | Search Results |
  28. |----------|---------------|
  29. | ![Homepage](screenshots/homepage.png) | ![Search](screenshots/search.png) |
  30. | Almanac | Solar system |
  31. |---------|--------------|
  32. | ![Almanac](screenshots/almanac.png) | ![Solar system](screenshots/solar-system.png) |
  33. | Games | ZimCity |
  34. |-------|---------|
  35. | ![Games](screenshots/games.png) | ![ZimCity](screenshots/zimcity.png) |
  36. | Zimipedia | Bookshelf |
  37. |-----------|-----------|
  38. | ![Zimipedia](screenshots/zimipedia.png) | ![Bookshelf](screenshots/bookshelf.png) |
  39. | Maps | ZimiTube |
  40. |------|----------|
  41. | ![Maps](screenshots/maps.png) | ![ZimiTube](screenshots/zimitube.png) |
  42. | Reddot | Catalog |
  43. |--------|---------|
  44. | ![Reddot](screenshots/reddot.png) | ![Catalog](screenshots/browse-library.png) |
  45. | Sharing | Make a ZIM |
  46. |---------|------------|
  47. | ![Sharing](screenshots/sharing.png) | ![Create](screenshots/create.png) |
  48. ## Install
  49. **macOS**
  50. ```bash
  51. brew tap epheterson/zimi
  52. brew trust --tap epheterson/zimi # Homebrew 6 and later
  53. brew install --cask zimi
  54. ```
  55. **Linux:** `sudo snap install zimi`, or the [AppImage](https://github.com/epheterson/Zimi/releases) (it updates itself; the window needs WebKitGTK 4.1 from your distro, otherwise Zimi opens in your browser).
  56. **Linux, no Python (a Pi, a USB disk):** `zimi-<version>-linux-x64.tar.gz` or `-arm64.tar.gz` from [Releases](https://github.com/epheterson/Zimi/releases); unpack it, `mkdir zimi-data zims` inside, then `./zimi serve -d`; settings stay in `zimi-data` beside it ([details](docs/features/operations.md#portable-linux-build)).
  57. **Windows:** the installer or portable zip from [Releases](https://github.com/epheterson/Zimi/releases).
  58. **Docker**
  59. ```bash
  60. docker run --network host -v ./zims:/zims -v ./zimi-config:/config epheterson/zimi
  61. ```
  62. `/zims` holds your ZIM files, `/config` keeps settings and indexes. Open http://localhost:8899. Host networking lets LAN discovery and seeding work; for bridge mode, Compose, rootless Podman and Kubernetes see [operations](docs/features/operations.md) and [networking](docs/deployment-networking.md).
  63. **Python**
  64. ```bash
  65. pip install zimi
  66. zimi serve ./zims --port 8899 # or ZIM_DIR=./zims zimi serve, or --zim-dir ./zims
  67. ```
  68. **Run at boot on Linux (systemd):** `zimi service print` shows the unit and `sudo /var/lib/zimi/venv/bin/zimi service install` writes it to /etc/systemd/system (the unit runs the Python of the command that installs it); the steps for a `zimi` user and its venv are at the top of the unit. ZIM files go in /var/lib/zimi/zims.
  69. **In the background without systemd** (a Pi, a USB disk): `zimi serve -d --zim-dir /path/to/zims` detaches and writes `zimi.pid` and `zimi.log` in the data directory; stop it with the `kill $(cat ...)` line it prints.
  70. Two packages: `pip install zimi` is the complete experience; `pip install zimi-mcp` is only the [MCP server](#mcp-server) and search, for AI agents (280 KB, no web app).
  71. Most people configure nothing. Everything is in Settings; `zimi config` prints every effective value and where it came from, and each `ZIMI_*` variable is documented in the guides below.
  72. ## Documentation
  73. - [Reading](docs/features/reading.md): search, the reader, Reader View, find in page, languages, PDFs, offline use.
  74. - [Apps](docs/features/apps.md): Zimipedia, Bookshelf, ZimiTube, ZimiExchange, Reddot and Maps.
  75. - [Saving](docs/features/saving.md): bookmarks, lists, likes, highlights, sync.
  76. - [Making ZIMs](docs/features/making-zims.md): every capture mode, folders and their metadata files, web archives.
  77. - [Saved web pages](docs/features/saved-pages.md): pages saved from Firefox, Chrome and Safari (complete, single file, web archive) as a ZIM.
  78. - [Getting & sharing](docs/features/getting-and-sharing.md): the catalog, downloads, auto-update, BitTorrent, Nearby.
  79. - [Access](docs/features/access.md): public access, accounts, per-ZIM allowlists, single sign-on.
  80. - [Operations](docs/features/operations.md): configuration, backup, air-gapped use, monitoring, updates.
  81. - [API & MCP](docs/features/api-and-mcp.md): the JSON API (`/openapi.json`), RAG chunks, the MCP server and its tools.
  82. - [Project NOMAD](docs/integrations/project-nomad.md): read NOMAD's Information Library in Zimi without copying it, and an offline research agent over the same files.
  83. ## MCP server
  84. ```bash
  85. pip install zimi-mcp
  86. zimi-mcp /path/to/zims
  87. ```
  88. ```json
  89. {
  90. "mcpServers": {
  91. "zimi": { "command": "zimi-mcp", "args": ["/path/to/zims"] }
  92. }
  93. }
  94. ```
  95. `zimi-mcp` is the MCP server and search alone, built from this repository and released with it. `pip install "zimi[mcp]"` gives the full install the same command, and `zimi mcp`. Three tools by default (search, read a page as Markdown, read one section), about 360 tokens of schema, sized for small local models; `--tools full` serves every tool. No web server is started. For Docker on another machine, run `docker exec -i zimi python3 -m zimi mcp` over ssh. See [API & MCP](docs/features/api-and-mcp.md#just-the-basics) for the tools and measured numbers, and the [SearXNG](docs/integrations/searxng.md) and [OpenWebUI](docs/integrations/openwebui.md) guides.
  96. ## Contributing
  97. Issues and ideas are welcome, and every one gets answered. See [CONTRIBUTING.md](CONTRIBUTING.md); security reports go privately per [SECURITY.md](SECURITY.md).
  98. ## License
  99. [GPL-3.0-or-later](LICENSE), like the Kiwix and openZIM libraries it builds on; 1.13.3 and earlier were MIT. Desktop and Docker builds bundle [libtorrent-rasterbar](https://libtorrent.org/) (BSD-3-Clause), see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
  100. ---
  101. Built with ❤️ in California by [@epheterson](https://github.com/epheterson) and [Claude Code](https://claude.ai/code).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.