从源码构建

依赖

依赖	版本要求
Node.js	>= 20
Rust	stable（通过 rustup 安装）
macOS	14+
Windows	10/11 + MSVC + WebView2

克隆与构建

1
2
3

git clone https://github.com/mcxen/qx.git
cd qx
npm install

开发模式

1	npm run tauri dev

编译并启动桌面应用，支持热重载。

代码检查

npx tsc --noEmit          # TypeScript 类型检查
npm run build              # 前端构建
npm run check              # 架构 + 文档 + i18n + shell + island 检查
cd src-tauri && cargo fmt --check && cargo check  # Rust 检查

打包发布

# macOS Apple Silicon
npm run tauri build -- --target aarch64-apple-darwin --bundles app

# Windows x64
npm run tauri build

项目结构

路径	内容
`src/`	React 前端，内置模块（剪贴板、RSS、截图、设置等）
`src/plugin/`	插件注册、运行时 iframe、RPC、宿主端口
`src-tauri/`	Rust 核心：市场、剪贴板、截图、CLI/文件/HTTP 端口
`public/doc/`	用户和开发者文档
`docs/`	内部架构文档
`scripts/`	检查脚本、Raycast 转换器、打包工具

开发规范

详见 AGENTS.md：

SOLID 原则在端口边界的应用
跨平台 Rust 策略（#[cfg(target_os)] 分离）
文件不超过 1000 行，按领域边界拆分
公共接口变更必须同步文档

← 插件系统 · 返回手册

从源码构建