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.
Что должно быть установлено, чтобы собрать или протестировать его?Нужен набор инструментов Rust, чтобы запустить cargo test --workspace. А на macOS для тестов также нужно разрешение Универсальный доступ (Accessibility) для скриптов, которые работают с окнами.
Готовы ли сборки для Linux и Windows к использованию прямо сейчас?Пока не подтверждено. Скрипты сборки для Linux и Windows есть в репозитории, но в README прямо указано, что на этих системах их ни разу не запускали.
Ely Office отправляет мои документы куда-нибудь?Нет. Файлы остаются в ваших локальных папках, а для работы приложениям не нужны ни аккаунт, ни облачный сервис.
Какие движки на самом деле отвечают за конвертацию документов?ElyDoc, ElyTable и ElyShow работают на LibreOfficeKit; ElyPDF использует MuPDF и Tesseract для распознавания текста (OCR); ElyMark отображает Markdown с помощью markdown-rs, RaTeX и отрисовщика mermaid на Rust.
Что такое ElyMail и ElyAgent?Они упомянуты как часть запланированного «второго релиза» и в текущей версии Ely Office недоступны.
Умеет ли ElyPDF больше, чем просто открывать PDF?Да, ElyPDF также поддерживает OCR и цифровые подписи, помимо базового чтения и редактирования PDF.
ElyTree — это полноценный графический интерфейс Git или просто просмотрщик?Его описывают как Git-клиент, что говорит о том, что он выполняет стандартные операции Git, а не только показывает историю репозитория.
Автор
ELY-Open-Source
Размер
78.3 MB
Звёзды
1.5K
Возраст
30 д
Коммиты · 90 дней