EdgeEver is a modern, open-source notes and knowledge base workspace. It preserves the classic, high-efficiency three-pane productivity workflow (Tree View · Note List · Editor) while offering an open data architecture and seamless AI Agent integration for complete ownership and smart productivity.

💡 Serverless & 100% Free Forever EdgeEver can run within Cloudflare's free quotas with no server purchase or VPS maintenance. Users who prefer a VPS, NAS, or home server can deploy the same application with Docker.

⭐ If EdgeEver is useful to you, consider giving it a Star. Your support helps more people discover the project.

Why EdgeEver

Many users of note-taking apps and personal knowledge bases simply want a reliable, open, and fast personal knowledge base. Existing mainstream solutions all present tradeoffs:

Solution Type	Typical Apps	Layout & User Experience	Sync Mechanism & Hosting Cost	AI & Agent Ecosystem
Traditional Cloud PKM	Evernote	Classic 3-pane layout, bloated over time	Tightening free tier, expensive subscription	Closed ecosystem, hard to plug into private AI
Local File Vaults	Obsidian	Local folders & tabs, lags with massive notes	Closed core, paid official sync, bloated attachments	Relies on community plugins, no native MCP/ACP
Lightweight Card / Block PKM	Memos / SiYuan	Stream cards or granular block architecture	Requires self-hosted server, or paid official sync	Focused on atomic notes, cognitive overhead for prose
Serverless Full-Stack Open PKM	EdgeEver	Classic 3-Pane + Rich Text & Markdown Dual View	Zero-Cost Cloudflare Serverless / Docker On-Premise	Native Built-In Remote MCP & Desktop ACP Protocol

EdgeEver fills this gap: The entire stack is open source, delivering truly seamless, low-latency, instant multi-device cloud sync with full self-hosting freedom. It keeps the three-pane layout you know, stays silky-smooth and lightweight even with 10,000+ notes, and ships native AI agents with zero-cost deployment.

Online Demo

Demo: https://demo.edgeever.org

The public demo resets every day at 3:00 AM (China Standard Time) and restores sample notes. Do not store private content there.

All-Platform Clients & Browser Extension

Client Downloads

The iOS app requires an Apple ID from outside mainland China.

Browser Web Clipper Extension

Smart Article Extraction: Automatically extracts clean article content into Markdown, preserving source URL and timestamp.
Selection & Context Menu Clipping: Clip selected text or right-click any image to create a note instantly without clutter.
Deep Social & Community Support: Tailored adapters for X (Twitter), Xiaohongshu, Zhihu, Reddit, GitHub, Bilibili, and YouTube.
Direct Self-Hosted Privacy: Clips transmit straight to your private instance without third-party server relay.

Key Features & Workflows

From multi-channel inspiration capture to deep visual expression and team collaboration, EdgeEver delivers frictionless, end-to-end workflows:

Featured Workflows in Action

💡 One-Prompt AI Mind Maps & Diagrams	📊 AI Database Tables & Online Forms

💬 One-Click WeChat Chat History Archiving	🎨 WeChat Official Account & Newsletter Styling

1. Universal Clipping & Media Storage

Cross-Platform One-Click Clipping: Extension tailored for Xiaohongshu, X (Twitter), Zhihu, Reddit, GitHub, YouTube, and Bilibili; one-click mobile sharing for photos and articles.
WeChat Chat History Archiving: One-click complete transcript import on macOS preserving participants, timestamps, attachments, and stickers. See WeChat Archiving.
Universal Attachments & Client Image Compression: Handles up to 1 GiB files; silent in-browser image compression shrinks files by 50%-90%.

2. Intelligent Visual Notes & Database Collaboration

Visual Diagram Notes & Professional Infographics: Prompt the AI companion to generate editable mind maps & flowcharts (see Design Guide); built-in templates produce infographics instantly.
AI Multi-Dimensional Tables & Public Forms: Natural language prompts build structured database tables with sample rows; launch public collection forms without login barriers.
Native Poster Notes & AI Visual Layout: Canvas-based structured poster notes with rich visual card layouts, responsive zooming, and direct AI companion collaboration.
Dual-View Editing & Public Knowledge Base: Seamlessly toggle between rich-text and raw Markdown; publish entire notebooks as standalone, navigable knowledge base websites.

3. Creator Publishing & Effortless Distribution

WeChat Official Account & Rich Copy: Transform notes into styled rich text with inline CSS, featuring one-click copy directly to newsletter editors.
Elegant Long-Image Posters & Multi-Format Export: Turn notes into stylized image poster cards; export individual notes to Markdown, HTML, or PDF effortlessly.
AI RSS Daily Digests: Built-in AI RSS plugin aggregates feeds, filters noise, and compiles concise daily digest notes.

4. Native AI Agents & Open Ecosystem

Native Agent Protocols (MCP & ACP): Built-in MCP lets external AI Agents read and organize notes; desktop app uses ACP to drive local agents (Codex, Antigravity, Claude Code, etc.) collaboratively.
Bring Your Own AI Models & Extensible Plugin API: Connect OpenAI, Anthropic, Gemini compatible providers; extend features via Plugin Development APIs.

5. Open Architecture, Cross-Platform & Security Foundation

Flexible Deployment & Unlocked Data: Run on Cloudflare Serverless (~150k notes for free) or Docker on-premise; standard SQLite storage with lossless full ZIP export/import.
All-Platform Coverage & Production Security: Official clients across Web, Android, iOS, macOS, Windows, Linux, and browsers; offline drafts, sync queues, and brute-force protection.

👉 Explore all 14 step-by-step showcases with screenshots: Complete Showcase & Workflows Guide

Deployment

Cloudflare is the recommended zero-server deployment. Docker is available for users who prefer a VPS, NAS, or home server.

For Cloudflare, choose either of the following online deployment options:

Option A: Deploy with an AI Agent (Recommended)

Copy the prompt below directly into an AI Agent (such as Codex, Claude, Cursor, WorkBuddy, Antigravity, OpenClaw, Hermes Agent, etc.). During execution, if access to GitHub or Cloudflare is required, review the requested permissions and follow the prompts to authorize access.

Deploy EdgeEver entirely through GitHub and Cloudflare:
1. Fork https://github.com/tianma-if/edgeever.
2. Create D1 `edgeever` and R2 `edgeever-resources` in Cloudflare.
3. In Workers & Pages, create a Worker named `edgeever` from the Fork's `main` branch.
   Use the repository root, keep Cloudflare's default Workers Builds deploy command,
   and ensure its API token can read and edit D1. Select Save and Deploy.
4. After the Worker is created, add the user's chosen password as the runtime Secret
   `EDGE_EVER_AUTH_PASSWORD` (preferably at least 32 characters).
   The username defaults to `admin`.
   If the user specifies another, set `EDGE_EVER_AUTH_USERNAME` as a Workers Builds
   variable before the next build.
5. Run the build again, verify `/api/health` and `/api/openapi.json`, then log in
   with that administrator username and password.
6. Enable and manually run the GitHub Actions workflow named `Update deployed EdgeEver`
   once so the Fork can automatically receive future stable releases and fixes.

Detailed requirements: AI Agent Cloudflare Deployment.

Option B: Manual Online Deployment

📖 Click to expand: 6-Step Web Manual Deployment Guide

Complete setup in 6 web steps:

Fork the Repository: Click Fork at the top right of GitHub to fork EdgeEver into your personal account.
Create Cloudflare Resources: Create D1 edgeever and R2 edgeever-resources.
Import & Configure the Project: Create a Worker named edgeever from the Fork's main branch in Cloudflare Workers & Pages. Use the repository root and keep Cloudflare's default Workers Builds deploy command, which runs in Cloudflare. Ensure its API token can read and edit D1. The deploy command creates the bindings; do not edit Fork files.
Choose the Administrator Password: Choose an administrator password, preferably at least 32 characters. Once the Worker is created, save it as the runtime Secret EDGE_EVER_AUTH_PASSWORD.
Build & Verify: Save and Deploy creates the Worker and starts a build. The initial build primarily initializes the Worker instance; if it fails due to missing administrator Secret, this is expected behavior. Simply add the runtime Secret EDGE_EVER_AUTH_PASSWORD from Step 4 and click retry. The username defaults to admin; to use another, set EDGE_EVER_AUTH_USERNAME as a Workers Builds variable before retrying. Once deployed, confirm /api/health returns 200, then log in with the configured username and password.
Enable Automatic Updates: Open the Fork's Actions tab, click I understand my workflows, go ahead and enable them, then manually run Update deployed EdgeEver once so the Fork can automatically receive future stable releases and fixes.

📖 For full step-by-step instructions and configuration details, see the Online Deployment Guide.

💡 Custom Domain & Access: After deployment, you can directly use the default *.workers.dev domain assigned by Cloudflare, or attach your own custom domain in the Worker settings under Settings → Domains & Routes.

💡 Enabling Cloudflare R2: While Cloudflare R2 provides a generous free storage tier that will never be exceeded in typical note-taking, enabling R2 requires activating an R2 subscription and adding a payment method. Cloudflare officially supports UnionPay, Visa, Mastercard, PayPal, Apple Pay, Google Pay, and other methods.

Option C: Deploy with Docker on VPS or NAS

Docker runs the same frontend, API routes, services, authentication, MCP implementation, and migrations as Cloudflare. The container uses SQLite with local files or S3-compatible attachment storage and supports amd64 and arm64. See Deploy EdgeEver with Docker and Self-hosting and Docker architecture.

Run the official installation script hosted on GitHub with the official GHCR container image:

curl -fsSL https://edgeever.org/install.sh | bash

This pulls the latest image, generates an administrator password, and starts EdgeEver via Docker Compose. Daily auto-updates are enabled by default; to update manually, run ~/edgeever/update.sh on the server.

💡 Network Note: The official image is hosted on GitHub Container Registry (GHCR). If pulls are slow in certain network environments, configure an appropriate network proxy or mirror.

Migration & Advanced Setup

Migration

If you want to migrate notes from other platforms to EdgeEver, please refer to the following simple migration guides:

Evernote Migration: Please refer to docs/evernote-migration-guide.md
flomo Migration: Please refer to docs/flomo-migration-guide.md
Memos Migration: Please refer to docs/memos-migration-guide.md
Notion Migration: Please refer to docs/notion-migration-guide.md

Native MCP Integration

In Profile -> API / MCP, generate an API token and copy the Remote MCP configuration to allow AI Agents (Claude Code, Cursor, Antigravity, OpenClaw, etc.) to safely access your knowledge base. Agents can read and write text notes, diagrams, tables, and poster notes, as well as manage notebooks, tags, attachments, revisions, templates, and prompts.

💡 Inspiration: Make AI your true knowledge orchestrator and creative co-pilot—instantly turn concepts into interactive mind maps, flowcharts, architecture diagrams, and structured tables, while supplying private context to your AI Agents. Paired with EdgeEver’s powerful rich-text editing and elegant typography, AI-assisted content becomes beautifully structured, polished, and publication-ready knowledge assets.

Multi-Account & Storage Analytics

A deployed instance supports multiple user accounts. Administrators can manage accounts under Profile -> Account Management. Each user receives an isolated workspace, complete with notebooks, notes, attachments, trash, imports/exports, and MCP tokens. A storage analytics dashboard offers real-time visibility into overall and per-account attachment usage.

Advanced Object Storage & Third-Party Image Hosting

OSS Object Storage: The instance owner can configure S3-compatible object storage under Settings → Advanced → OSS object storage. Changing storage does not migrate or affect existing attachments.
Desktop PicGo Integration: The desktop app optionally integrates with a local PicGo client service, uploading inserted images directly to GitHub, SM.MS, Upyun, Qiniu, or custom image hosts to minimize self-hosted storage and bandwidth consumption.

Plugins & Themes

Web and desktop apps support functional plugins and custom themes installable with one click from the official marketplace, GitHub, or a manifest URL, syncing across your workspace. Developers can extend capabilities using @edgeever/plugin-api. See Plugin Development and Plugin Marketplace Policy.

Developer Guide & Architecture

Tech Stack

Bun workspace monorepo covering Web, API, site, and shared packages.
Frontend: Vite, React, React Router, TanStack Query; UI built with Tailwind CSS, shadcn/ui, and Radix UI.
Editor: TipTap / ProseMirror with Markdown support; PWA powered by vite-plugin-pwa, Workbox, and Dexie.
Android App: Expo + React Native in apps/mobile with SQLite local storage and incremental sync.
iOS App: Native SwiftUI (iOS 17+) in apps/ios with TipTap EditorBundle and GRDB local mirroring/outbox, aligned with the Android app shell.
Native Desktop: Electron + Rust sidecar balancing cross-platform consistency with high-performance local SQLite storage, offline editing, and incremental sync.
Web Clipper: Manifest V3, Mozilla Readability, and Turndown for Chrome, Microsoft Edge, and Firefox.
Backend: Hono/Zod application delivering REST API and Remote MCP; Cloudflare Workers/D1/R2, and Docker Bun/SQLite/local files or S3.
Site: Astro static site in apps/site, built independently and deployable to Cloudflare Pages.

Quick Start

bun install
bun run dev

Local development logs in automatically with owner / edgeever-local-dev. Log out manually to test the login screen.

Project Structure

apps/web          Vite + React frontend, PWA, offline drafts, and sync queue
apps/extension    Chrome/Edge/Firefox Manifest V3 web clipper extension
apps/api          Cloudflare Worker + Hono API, MCP endpoint
apps/mobile       Expo + React Native Android App
apps/ios          Native SwiftUI iOS App (TipTap EditorBundle, GRDB)
apps/desktop      Electron desktop shell, preload bridge, and native packaging
apps/site         Astro official website, independently deployable
packages/client   Shared API client for web and mobile
packages/shared   Shared types, Zod schemas, TipTap / Markdown converters
crates/desktop-sidecar
                  Rust sidecar managing local SQLite, offline data, and backup
scripts           Wrangler wrappers, password hashing, CLI, MCP stdio bridge, ENEX import
migrations        Shared, append-only SQLite migrations for D1 and local setups
docs              Architecture, migration, and deployment guides
.github/workflows CI for packaging, deployment, and releases
wrangler.toml     Cloudflare Workers, Assets, D1, and R2 configuration

⚙️ Architecture Design & Sync Implementation Details (Click to expand)

Content Formats

EdgeEver stores three content representations simultaneously:

content_json      TipTap/ProseMirror document, the authoritative editor format
content_markdown  Used by APIs, AI Agents, imports, and exports
content_text      Used for search, summarization, and indexing

Export or import EdgeEver ZIP files from Profile -> Import & Export. The notes/ directory contains standard Markdown files for reading or migration, while structured data enables full restoration between EdgeEver instances. Existing data is preserved on import; matching IDs are updated.

Image Compression

Image compression happens in the Web client before upload and is controlled by the Compress note images setting. When enabled, PNG, JPEG, WebP, and AVIF files are converted to WebP when beneficial, with the longest edge limited to 2560px. If compression does not reduce size, the original file is kept.

EdgeEver avoids Worker-side image processing to reduce compute and image-processing quota usage. REST API and MCP upload paths store the file content provided by the client without additional server-side compression.

Sync Timing

Web, PWA, and desktop upload memo edits after 30 seconds of inactivity and check for remote changes every 5 minutes while visible; focus and manual refresh remain immediate. Adjust DEFERRED_MEMO_SYNC_DELAY_MS and BACKGROUND_WORKSPACE_REFRESH_INTERVAL_MS in apps/web/src/lib/workspace-refresh.ts.

Community & Feedback

Please report bugs, suggest features, and ask deployment questions on GitHub Issues so other users can search and reference them.
Read Contributing Guidelines before submitting code. If your fork is used to deploy EdgeEver, keep main dedicated to deployment; branch from official upstream/main to develop and open PRs.

EdgeEver is a free and open-source project. Sustaining client development across macOS, Windows, Linux, iOS, and Android, hardware testing, code-signing certificates, and multi-runtime architecture requires continuous resources.

Support EdgeEver — Donate via WeChat Pay or Alipay
Sponsors & Partners — Support infrastructure, tooling, or collaboration

Acknowledgements

Product design references public UX patterns from Evernote and Notion. All features are independently implemented by EdgeEver.
Diagramming notes reference design patterns from XMind and ProcessOn.
Poster canvas adapts templates and font engines from Qiaomu Design by joeseesun under the MIT license.
Image card themes reference visual styling from FireflyCard.

Trademarks & Brand

The EdgeEver name, logo, and brand assets identify the official project. Forks and modifications may note they are "based on EdgeEver" but must not imply official affiliation. The open-source license does not grant trademark rights.

Disclaimer

EdgeEver is an independent open-source project developed and maintained by the community. It is not affiliated with, sponsored by, or endorsed by Evernote Corporation or any commercial entities.

EdgeEver is self-hosted software. Aside from the official demo, maintainers do not host, control, or review user content.

README.md Unescape Escape

EdgeEver