齐米
为您的ZIM文件提供现代体验。
Kiwix 将世界知识打包成ZIM文件。Zimi通过丰富的web UI、快速的JSON API和用于AI代理的MCP服务器,让他们感觉像真正的互联网。一切都可以离线工作,用你的语言。
盒子里有什么
- 跨源搜索。 使用片段和缩略图在所有来源上进行并行全文搜索。
- 跨语言导航。 在语言之间切换文章并下载缺失的文章。
- 发现。 每日更新卡片:今日图片、今日、引文、文字、书籍、目的地、谈话、漫画、国家。
- 书签和历史。 感觉你在一个真正的浏览器中,保存你的位置。
- Kiwix目录。 通过即时语言过滤下载10个类别的1000多个Kiwix档案。
- 图书馆管理。 自动更新、密码保护、下载队列。
- 收藏和收藏夹。 对源进行分组,以便于访问和范围搜索。
- JSON API。 每个功能都可以通过令牌身份验证以编程方式访问。
- 台式机和移动设备。 原生macOS和Python应用程序。部署到任何地方。
截图
文章阅读器
语言
不是事后的想法。语言深度融入了Zimi的各个方面,因此您可以专注于您的内容并有宾至如归的感觉。享受经过筛选的列表、标记的来源、RTL支持和无微不至的摇滚乐。
- 10种语言。 英语、法语、德语、西班牙语、葡萄牙语、俄语、中文、阿拉伯语、印地语、希伯来语。
有什么不对吗? 打开一个问题。
安装
macOS```bash
brew tap epheterson/zimi && brew install --cask zimi
或从以下网址下载 GitHub 发布.
### Linux```bash
sudo snap install zimi
或者抓住 AppImage.
码头工人```bash
docker run -v ./zims:/zims -v ./zimi-config:/config -p 8899:8899 epheterson/zimi
`/zims` ZIM文件所在的位置。 `/config` 持久化缓存、索引和设置。打开http://localhost:8899.
Docker Compose```yaml
services:
zimi:
image: epheterson/zimi
container_name: zimi
restart: unless-stopped
ports:
- "8899:8899"
volumes:
- ./zims:/zims # ZIM files go here
- ./zimi-config:/config # cache, indexes, settings
python```bash
pip install zimi
ZIM_DIR=./zims zimi serve --port 8899
### 环境变量
|变量|默认值|描述|
|----------|---------|-------------|
| `ZIM_DIR` | `/zims` |ZIM文件的路径(已扫描 `*.zim` 启动时)|
| `ZIMI_DATA_DIR` | `/config` (Docker)或 `$ZIM_DIR/.zimi` |缓存、索引和设置。在Docker中单独挂载。 |
| `ZIMI_MANAGE` | `1` |图书馆管理员。 `0` 禁用。 |
| `ZIMI_MANAGE_PASSWORD` | _(无)_ |保护图书馆管理|
| `ZIMI_AUTO_UPDATE` | `0` |自动更新ZIM(`1` 启用)|
| `ZIMI_UPDATE_FREQ` | `weekly` | `daily`, `weekly`,或 `monthly` |
| `ZIMI_RATE_LIMIT` | `60` |请求/分钟/IP。 `0` 禁用。 |
## API
|端点|描述|
|----------|-------------|
| `GET /search?q=...&limit=5&zim=...&fast=1&lang=...` |全文搜索。 `fast=1` 仅适用于冠军赛。 `lang` 按语言过滤。 |
| `GET /read?zim=...&path=...&max_length=8000` |以纯文本形式阅读文章|
| `GET /suggest?q=...&limit=10&zim=...` |标题自动补全|
| `GET /list` |列出所有包含元数据的来源|
| `GET /article-languages?zim=...&path=...` |文章可用的所有语言|
| `GET /catalog?zim=...` |zimgit ZIMs的PDF目录|
| `GET /snippet?zim=...&path=...` |短文本片段|
| `GET /random?zim=...` |随机文章|
| `GET /collections` |列出收藏|
| `POST /collections` |创建/更新集合|
| `DELETE /collections?name=...` |删除收藏|
| `GET /resolve?url=...` |将外部URL解析为ZIM路径|
| `POST /resolve` |批量解析: `{"urls": [...]}` |
| `GET /health` |使用版本进行健康检查|
| `GET /w//` |提供生ZIM内容物|
### 例子```bash
# Search across all sources
curl "http://localhost:8899/search?q=python+asyncio&limit=5"
# Search in French only
curl "http://localhost:8899/search?q=eau&lang=fr&limit=5"
# Find all languages for an article
curl "http://localhost:8899/article-languages?zim=wikipedia&path=A/Water"
# Read an article
curl "http://localhost:8899/read?zim=wikipedia&path=A/Water_purification"
MCP服务器
Zimi包括一个用于AI代理的MCP服务器。```json
{
"mcpServers": {
"zimi": {
"command": "python3",
"args": ["-m", "zimi.mcp_server"],
"env": { "ZIM_DIR": "/path/to/zims" }
}
}
}
对于远程主机上的Docker:```json
{
"mcpServers": {
"zimi": {
"command": "ssh",
"args": ["your-server", "docker", "exec", "-i", "zimi", "python3", "-m", "zimi.mcp_server"]
}
}
}
工具: search (与 lang 过滤器), read, suggest, list_sources, random, article_languages, read_with_links, deep_search, list_collections, manage_collection, manage_favorites
贡献
看 贡献.md.
许可证
麻省理工学院
建于❤️ 加利福尼亚州by @以弗所生 和 克劳德代码.
