ElyOffice README

项目的 README,来自 github.com/ELY-Open-Source/ElyOffice。合并为一个 markdown 文件:README.md。

Ely Office

Offline-first desktop apps in Rust and GPUI. Files stay in your folders; no account, no cloud service.

Download from office.elygpui.com or the latest release: Windows, macOS (Apple silicon and Intel) and Linux (AppImage, deb, rpm, Arch, Nix; Debian 11 and Ubuntu 20.04 or newer). Each platform has one installer with every app, and an update replaces them all.

App Does Engine
ElyDoc Word processing (DOCX, ODT) LibreOfficeKit
ElyTable Spreadsheets (XLSX, ODS, CSV) LibreOfficeKit
ElyShow Presentations (PPTX, ODP) LibreOfficeKit, system media
ElyPDF PDF reading and editing, OCR, signatures MuPDF, Tesseract
ElyMail Mail over IMAP, POP3 and SMTP; follows the system proxy own IMAP and POP3, mail-send, SQLite
ElyTree Git client Git
ElyMark Markdown pulldown-cmark, RaTeX, mermaid-rs-renderer; MuPDF for PDF export
ElyAgent Second release Kigi CLI

ElyMail signs in to Microsoft with OAuth, to Gmail and iCloud with an app password, and to QQ Mail, 163 and 126 with an authorization code.

Build

Install Rust with rustup (rust-toolchain.toml pins the version), then the system packages. Every system also needs Git, Python 3, curl, Node.js 22.18 or newer (the first to run the site's TypeScript tests unflagged) and pnpm (check.sh and the site use the last two).

sudo apt install build-essential pkg-config git curl python3 docker.io libdbus-1-dev libfontconfig-dev libxcb1-dev libxkbcommon-x11-dev
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - && sudo apt install nodejs
sudo dnf install gcc make pkgconf-pkg-config git curl python3 nodejs npm moby-engine dbus-devel fontconfig-devel libxcb-devel libxkbcommon-x11-devel
sudo pacman -S --needed base-devel git curl python nodejs npm docker dbus fontconfig libxcb libxkbcommon-x11
sudo npm install -g pnpm

scripts/doctor.sh checks each of these for the system it runs on.

scripts/doctor.sh                 # toolchain versions
scripts/fetch-references.sh       # upstream sources at pinned commits
scripts/build-libreoffice.sh      # patched LibreOffice 26.2.6.3 (about an hour)
scripts/build-mupdf.sh            # patched MuPDF 1.28.5
scripts/build-git.sh && scripts/fetch-git-lfs.sh
scripts/fetch-tessdata.sh
cargo build -p ely-lok --bins -p ely-pdf-worker
cargo run -p ely-doc              # or ely-table, ely-show, ely-pdf, ely-mail, ely-tree, ely-mark

ElyMail needs a Microsoft client ID at build time: put ELY_MICROSOFT_CLIENT_ID=<id> in cred.txt at the repository root (git ignores it).

The scripts run on macOS, on Windows (LibreOffice under Cygwin, MuPDF with MSBuild) and on Linux inside packaging/linux/container.sh, an AlmaLinux 8 image that keeps the binaries on glibc 2.28.

Experimental R macros

ElyTable can run local R macros on a selected range, including values, header formatting and column widths. See docs/r-macros.md for setup, the small API and its limits. Requires R (Rscript) and a LOK engine built with patch 0081.

Release

Pushing a v* tag runs .github/workflows/release.yml, four jobs that wait for no other, all on our own machines. Each job first checks the gates and builds nothing if one fails: the release notes state how many fixes were not reviewed again and why a release comes less than seven days after the last (scripts/release-gate.py); docs/perf/ holds this version's benchmark for the system and its first opens after install and after reboot, with a reason for each case over 30% slower (tests/perf/baseline.py); pr.yml passed on the tagged commit; the host's cargo, and the container's on Linux, is huacnlee/cargo. Self-hosted runners build macOS (arm64, and Intel under Rosetta), Windows and Linux x86_64 (in the AlmaLinux 8 container on an Omarchy host) with scripts/ci.sh; there is no Linux arm64 release. Each job uploads its packages and update manifests; x86_64 Linux alone uploads the source archives. The Linux job also builds ely-office, one deb, rpm and Arch package that holds every app and one copy of the LibreOffice kernel for ElyDoc, ElyTable and ElyShow (packaging/linux/bundle.sh). macOS builds are signed and notarized.

Tests

cargo test --workspace; the script tests in tests/scripts, listed in its README (the window tests need macOS Accessibility permission; Linux tests run in containers); the benchmarks tests/perf/bench.py and tests/perf/folder-search.rs; the first opens of the installed apps tests/perf/firsts.py install and reboot (on Windows it records Microsoft Office's beside them, ungated); the idle engines tests/perf/idle.py (no CPU in ten minutes, memory within a tenth of tests/perf/idle.json; part of scripts/release-tests.sh); the load tests tests/perf/load.py (many large documents open and edited at once, the command line editing the one being typed in) and tests/perf/pdfs.py, on Linux through tests/perf/linux.sh.

Documents

PRD.md Requirements
agents.md Stack, rules and commands; the single source of truth
tests/scripts/README.md Each test script: what it checks and what it needs
tests/fixtures/README.md Each shared test sample
tasks/TASKS.md Progress
docs/decisions.md Decision log, by date
docs/help.md Help: opening and saving, panels, recovery, offline limits, repositories, mail
patches/UPSTREAM.md The patches that fix upstream defects and could go upstream
docs/compatibility.md Compatibility list: each section last verified for 0.1.11; Office on the web opened 30 Ely-saved files and 18 large, odd and extreme ones at 0.1.15
docs/accessibility.md Accessibility and language review
docs/perf/ Benchmark records
docs/licenses.md Licences and sources
docs/acceptance.md Audit acceptance: each item, its task and its last review
CONTRIBUTING.md Opening a pull request

Licence

MIT (LICENSE). Third-party components keep their own licences; see docs/licenses.md.

ElyOffice (ELY-Open-Source/ElyOffice)

正在搜索数据库…

这是什么?Ely Office 是一套离线优先的桌面办公应用,使用 Rust 和 GPUI 工具包开发,涵盖文字处理、电子表格、演示文稿、PDF、Git 和 Markdown。所有内容都保存在本地文件夹中,无需云端账户。
这是一个应用还是多个独立应用?是多个独立的原生应用:ElyDoc 用于文字处理,ElyTable 用于电子表格,ElyShow 用于演示文稿,ElyPDF 用于 PDF,ElyTree 是 Git 客户端,ElyMark 用于 Markdown。大多数文档类应用基于 LibreOfficeKit 运行,而 ElyPDF 使用 MuPDF 和 Tesseract。
我该如何构建它?在 macOS 上,运行 packaging/macos/release.sh,即可为每个应用构建 .app 包和 .dmg,并在 dist/ 中生成源码压缩包。Linux 和 Windows 的等效构建脚本位于 packaging/linux 和 packaging/windows 中。
构建或测试它需要安装什么?运行 cargo test --workspace 需要安装 Rust 工具链。在 macOS 上,测试套件还需要获得“辅助功能”权限,以便窗口脚本正常运行。
Linux 和 Windows 版本现在可以直接使用吗?目前尚未确认。仓库中已有 Linux 和 Windows 的打包脚本,但 README 明确说明这些脚本从未在相应系统上运行过。
Ely Office 会把我的文档发送到其他地方吗?不会。文件保存在你的本地文件夹中,应用运行也不需要账户或云服务。
实际完成文档转换工作的是哪些引擎?ElyDoc、ElyTable 和 ElyShow 由 LibreOfficeKit 驱动;ElyPDF 使用 MuPDF 和 Tesseract 进行 OCR;ElyMark 使用 markdown-rs、RaTeX 以及 Rust 版的 mermaid 渲染器来渲染 Markdown。
ElyMail 和 ElyAgent 是什么?它们被列为计划中的“第二版本”的组成部分,目前的 Ely Office 版本中尚不可用。
ElyPDF 能做的不只是查看 PDF 吗?能。除了基本的 PDF 阅读和编辑之外,ElyPDF 还支持 OCR 和数字签名。
ElyTree 是完整的 Git 图形界面,还是仅是查看器?它被描述为 Git 客户端,这说明它能处理标准的 Git 操作,而不仅仅是显示仓库历史。
大小
78.3 MB
星标
1.5K
时长
30天
提交 · 90 天