MeiliFinder ʕʘ̅͜ʘ̅ʔ

终端的终极 Meilisearch 客户端！

MeiliFinder 是一个使用 Rust 🦀 和 Ratatui 构建的美观且快速的基于终端的 Meilisearch 客户端。

为什么选择 MeiliFinder？

Meilisearch 很棒；但是没有官方客户端可用。虽然有一些社区构建的客户端，但它们大多是基于 Web 的，并且缺少重要功能。如果你像我一样喜欢终端或者讨厌鼠标，你可能想使用基于终端的客户端来与 Meilisearch 交互。这就是 MeiliFinder 的用武之地。它快速、健壮、轻量且易于使用。它也是开源的，所以你可以为项目做出贡献并使其变得更好。

功能

• 搜索文档
• 通过排序和筛选查询搜索文档
• 分页搜索文档
• 删除单个文档
• 通过筛选批量删除文档
• 连接到多个 Meilisearch 实例
• 编辑文档
• 更新索引设置
• 动态切换索引和实例
• 任务预览
• settings.json 文件用于自定义应用程序
• Toast 通知

使用

克隆仓库，在根目录中运行 cargo run。如果在根目录中没有 instances.json 文件，它将提示您输入 Meilisearch 实例 URL 和 API 密钥。一旦输入详细信息，应用程序将保存信息到新的 instances.json 文件，您就可以开始搜索文档。

要退出应用程序，按 q 或 Ctrl+C。

截图

快捷键

普通模式

• tab - 在应用程序的不同标签页之间切换。
• r - 刷新当前列表。
• s - 进入搜索模式（插入搜索查询）。
• 上/下 - 在当前列表中导航。
• Enter - 选择当前索引/实例。
• Space - 快速预览突出显示的文档。
• Ctrl+u - 重置所有搜索查询。
• q - 退出应用程序。
• Ctrl+C - 退出应用程序。

搜索模式

• Esc - 退出搜索模式。
• tab - 在搜索/过滤/排序查询之间导航。
• Enter - 执行搜索。

预览模式

• Esc - 退出预览模式。
• backspace - 进入删除模式。

删除模式

• Esc - 退出删除模式。
• backspace - 确认删除。

instances.json 文件（可选）

instances.json 文件是一个 JSON 文件，用于存储 Meilisearch 实例 URL 和 API 密钥。应用程序使用此文件连接到 Meilisearch 实例。您可以将多个实例添加到文件中，并实时切换它们。

文件应如下所示

[
	{
		"id": "1",
		"name": "Your Meilisearch Instance Name",
		"host": "https://your-Meilisearch-instance.com",
		"primary_key": "your-api-key"
	}
]

请参阅根目录中的示例 sample.instances.json 文件。您可以将其重命名为 instances.json 并将其 Meilisearch 实例详细信息添加到其中。

全局安装

要全局运行它，您可以使用 cargo binstall MeiliFinder 安装应用程序。确保您已安装 binstall binstall 仓库。安装完成后，您只需在终端中运行 MeiliFinder 即可调用应用程序。这是一个二进制包，而不是库，因此您不应将其用作依赖项。

我可能会在将来提供 Windows/MacOS/Linux 的预构建二进制文件，或者将其发布在 Homebrew / Winget 上。

致谢

• Meilisearch 提供了 Rust SDK。
• Ratatui 提供了美观的 TUI 框架。

许可证

MIT

限制

目前，应用程序只能处理 ASCII 或 1 字节 UTF-8 字符输入。如果您正在输入非 ASCII 字符（例如 "ö"，"ß" 等），应用程序将忽略输入。