# openkylin-browser-ai

**Repository Path**: openkylin/openkylin-browser-ai

## Basic Information

- **Project Name**: openkylin-browser-ai
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-10-28
- **Last Updated**: 2026-11-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 小K网页助手（Xiao K browser assistant）

面向 Firefox 的浏览器 AI 助手，通过 Native Messaging 连接 openKylin AI 子系统，提供 AI 对话、网页总结与问答、翻译、图片文字提取和标签页操作等功能。本项目包含 Firefox 扩展和本地宿主（Native Host）源码。

## 依赖要求

### 运行环境

- **openKylin 3.0**：提供本项目所需的 openKylin AI 子系统。
- **Firefox 142 或更新版本**。
- **Native Host**：安装 `kylin-genai-native-host` 软件包，用于连接扩展与 AI 子系统。
- **可用模型**：在系统 AI 模块管理器中配置并启用模型；具体功能取决于模型能力。图片文字提取还需要系统 OCR 支持。

扩展与 Native Host 可以分别安装。仅安装扩展时可以打开侧边栏，使用 AI 功能需要本地宿主及 AI 子系统。

### 开发与构建

| 用途 | 依赖 |
| --- | --- |
| 扩展开发、检查与打包 | Node.js 22 或更新版本、npm；`web-ext` 和 `markdown-it` 的版本由 `package-lock.json` 锁定 |
| 辅助脚本及部分测试 | Python 3 |
| Native Host 编译 | C++17 编译器、CMake、pkg-config、`libglib2.0-dev`、`libkysdk-genai-nlp-dev`；OCR 支持需要 `libkysdk-coreai-vision-dev` |
| Native Host DEB 打包 | `build-essential`、`dpkg-dev`、`debhelper`，以及上述编译依赖；完整构建依赖见 `debian/control` |

构建命令及源码审核复现步骤见 [SOURCE_BUILD.md](SOURCE_BUILD.md)。

## 目录结构

| 目录或文件 | 作用 |
| --- | --- |
| `firefox/` | Firefox 扩展源码，包括侧边栏、后台逻辑、网页脚本、样式和隐私说明；扩展打包的输入目录 |
| `firefox/_locales/` | 中英文界面文案 |
| `firefox/icons/` | 扩展图标 |
| `firefox/vendor/` | 随扩展打包的第三方 JavaScript 库及许可证 |
| `native-host/` | 本地宿主 C++ 源码、CMake 配置和 Firefox Native Messaging 注册文件 |
| `debian/` | Native Host 的 DEB 打包配置 |
| `scripts/` | 测试、宿主注册、构建辅助、源码打包及集成验证脚本 |
| `docs/` | Mozilla 签名与发布、审核说明、系统集成等文档 |
| `demo/` | 实验演示文件，包括未签名扩展的测试方案 |
| `dist/` | 生成的扩展 ZIP、源码 ZIP、下载的签名 XPI 和其他构建产物，不纳入 Git |
| `node_modules/` | npm 安装的开发依赖，不纳入 Git |
| `package.json` / `package-lock.json` | npm 脚本、依赖声明及锁定版本 |
| `SOURCE_BUILD.md` | 构建环境、执行步骤和审核复现说明 |

扩展 ID 为 `openkylin-browser-ai@openkylin.top`，本地宿主名称为 `org.openkylin.browser_ai`。系统预装所需的签名 XPI 和 Firefox 策略由独立的 `openkylin-default-settings` 项目维护。