OmniBox - 小黑

英文 | 简体中文

文档

OmniBox 文档

简介

OmniBox（小黑）是一个简单、跨平台、一体化的 AI 知识中心。你只需收集内容，然后随时提问。

核心功能

1. 通过浏览器扩展将网页的主要内容保存到 OmniBox。
2. 上传并端到端解析与索引 PDF、Word、PPT、MP3 等格式的文件。
3. Markdown 编辑与渲染（公式、思维导图、流程图、时序图、甘特图、乐谱等）。
4. 基于互联网和本地数据库的问答与写作。
5. Flash：在 iOS 上快速捕捉转瞬即逝的想法，支持语音录音与文字笔记。
6. Share：直接从 iOS 无缝分享文件到 OmniBox。
7. 微信机器人：随时随地通过微信将文件、网页、视频、语音消息、文字及聊天记录保存到 OmniBox。
8. 用户与团队系统、权限管理、共享管理、多租户、多语言、深色模式、移动端响应式设计等。

快速入门

欢迎使用我们的在线服务：omnibox.pro，支持通过邮箱、Google 和微信登录。

浏览器扩展

浏览器扩展安装 | OmniBox 文档

部署

本地部署

本地开发

git clone --recurse-submodules https://github.com/import-ai/omnibox.git
cd omnibox
cp example.env .env
bash scripts/dev.sh up -d --build

路线图

• Agent、文件夹与文档的公开分享
• 微信机器人
• 开放 API
• 微信小程序
• RSS 订阅

星标历史

OmniBox (小黑) 快速上手指南

OmniBox 是一款简单、跨平台的一站式 AI 知识库工具。只需收集内容，即可随时提问。

环境准备

在开始本地部署或开发前，请确保您的系统满足以下要求：

• 操作系统：Linux / macOS / Windows (需安装 WSL2 或 Docker Desktop)
• 核心依赖：
  • Git
  • Docker 及 Docker Compose
• 网络环境：由于项目托管于 GitHub，国内用户建议配置代理或使用镜像加速，以确保 git clone 和拉取 Docker 镜像顺畅。

安装步骤

通过 Docker Compose 快速启动本地开发环境：

1. 克隆项目代码 使用 --recurse-submodules 参数以确保拉取所有子模块：

   git clone --recurse-submodules https://github.com/import-ai/omnibox.git
   cd omnibox
   

2. 配置环境变量 复制示例配置文件为正式配置文件：

   cp example.env .env
   

   提示：如需自定义数据库密码或 API Key，请编辑 .env 文件。

3. 启动服务 执行脚本一键构建并启动所有容器（包括后端、前端、数据库等）：

   bash scripts/dev.sh up -d --build
   

4. 访问服务 启动完成后，通常在浏览器访问 http://localhost:3000 (具体端口请参考 .env 配置或终端输出日志) 即可使用。

基本使用

1. 网页内容采集 (浏览器插件)

• 安装 OmniBox 浏览器扩展程序。
• 浏览任意网页时，点击插件图标，即可将当前页面的主要内容保存至您的 OmniBox 知识库中。

2. 文件上传与解析

• 登录 OmniBox Web 界面。
• 直接拖拽上传 PDF、Word、PPT、MP3 等格式文件。
• 系统将自动进行端到端的解析与索引，完成后即可针对文件内容进行问答。

3. 微信快捷保存 (特色功能)

• 绑定 OmniBox 微信机器人。
• 在微信中直接发送文件、网页链接、语音消息或聊天记录给机器人。
• 内容将自动同步至您的个人知识库，实现“随时随地”收集。

4. 知识问答与创作

• 在对话框中输入问题，OmniBox 将结合互联网信息与您本地知识库（已上传的文档、网页）进行综合回答。
• 支持 Markdown 编辑，可渲染公式、思维导图、流程图等多种格式。