Documentation

Getting Started

Evern is open source under the Apache 2.0 license. To build from source, you need the Rust toolchain, platform-specific SDKs, and the UniFFI binding generator.

Prerequisites

Rust: Install via rustup (latest stable)
Android: Android Studio (2024.2+) with NDK r27+, CMake 3.22+
iOS: Xcode 16+ with iOS 17+ SDK (macOS only)
Build tools: cargo-ndk, cargo-lipo, uniffi-bindgen-cli

Clone and Build

build from source

# Install Rust targets

rustup target add aarch64-linux-android \

armv7-linux-androideabi x86_64-linux-android

rustup target add aarch64-apple-ios \

x86_64-apple-ios aarch64-apple-ios-sim

# Install build tools

cargo install cargo-ndk cargo-lipo uniffi-bindgen-cli

# Clone the repository

git clone https://github.com/scottdaly/evern.git

cd evern/core

# Build for Android (outputs .so to jniLibs)

cargo ndk -t arm64-v8a -t armeabi-v7a \

-t x86_64 \

-o ../android/app/src/main/jniLibs \

build --release

# Build for iOS (universal framework)

cargo lipo --release

# Generate UniFFI bindings

uniffi-bindgen generate \

evern-core/src/evern_core.udl \

--language kotlin \

--out-dir ../android/app/src/main/kotlin/

uniffi-bindgen generate \

evern-core/src/evern_core.udl \

--language swift \

--out-dir ../ios/Evern/Bridge/

# Run Rust core tests

cargo test -p evern-core

After building the Rust core, open the Android project in Android Studio (android/) or the iOS project in Xcode (ios/Evern.xcodeproj) to build and run on an emulator or device. See Architecture > Building from Source for platform-specific setup details and common build errors.

Pages

01 Architecture How the Rust core, UniFFI bindings, and native UI layers fit together. Includes building from source and the repository layout. 02 Output Rendering How Evern transforms raw terminal output into structured content through a three-layer pipeline with graceful degradation. 03 Voice Input On-device speech recognition, the developer dictionary, spoken syntax expansion, and how the personal correction system works. 04 Transport SSH and Mosh protocol details, automatic transport upgrade, reconnection behavior, and the security model. 05 Design Identities The two-layer theme architecture, chrome identity tokens, terminal palette model, and how to create or import themes. 06 API Reference The CoreApi UniFFI surface — session lifecycle, terminal I/O, profiles, voice, intelligence, and error handling with Kotlin examples.

Contributing

Evern is licensed under Apache 2.0. Contributions are welcome — especially Layer 2 parsers for additional AI agents, terminal palette definitions, and platform-specific fixes. See the GitHub repository for open issues and contribution guidelines.

The project uses GitHub Actions for CI. The rust-core.yml workflow builds the Rust core for all targets, runs tests, generates UniFFI bindings, and runs Kotlin/Swift runtime smoke tests. Pull requests require all checks to pass before merging.