writeme
This is designed to be a text editor that help you to interact with AI and took notes with super powers, by using our awesome
Features
- AI-Powered Editing: Research workspace notes with source links; per-note Markdown proposals require explicit approval before application in database-backed storage. Filesystem-backed proposals remain review-only to avoid overwriting external edits.
- Markdown First: Full Markdown support using Tiptap and Unified/Remark ecosystems.
- Graph Visualization: Interactive 2D force-directed graph to visualize connections between notes and hashtags.
- Integrated Terminal: WTerm with Ghostty rendering and node-pty shells on desktop; a virtual just-bash shell in the browser.
- Read It Later: Web content scraper that transforms articles into clean, readable notes.
- Hybrid Storage: Support for both local filesystem (direct file access) and database-backed (Dexie/SQLite) storage modes.
- Rich Media & Extensions: Support for Excalidraw, Mermaid diagrams, KaTeX math, and Shiki syntax highlighting.
- Cross-Platform: Electron desktop application, Progressive Web App (PWA), and Capacitor iOS/Android packages. AI is disabled in the mobile packages.
Demo
Create a note in the browser, add a short plan, and find it again with search.
Recorded by the Playwright demo test.
Installation
macOS — Homebrew
brew tap g4rcez/writeme
Desktop app:
brew install --cask writeme
CLI:
brew install g4rcez/writeme/writeme
Desktop downloads
Download the v1.1.0 desktop release for your platform:
| Platform | Package | Download |
|---|
| macOS (Apple Silicon / ARM64) | Unsigned .dmg | Download |
| Windows (x64) | Installer (.exe) | Download |
| Linux (Debian/Ubuntu, x64) | .deb | Download |
| Linux (Fedora/RHEL, x64) | .rpm | Download |
The v1.1.0 macOS download targets Apple Silicon only and is unsigned. See the release notes for first-launch steps.
Writeme CLI
The desktop app includes a platform-matched writeme CLI. In the desktop app, open the command palette and run Install CLI. Then use writeme . to open the current directory as a vault, or writeme /path/to/note.md to open a file. The --wait (or -w) flag makes file opening suitable for external-editor integrations.
Alternatively, install the portable npm package with Node.js 22.13 or later:
npm install --global @writeme.dev/cli
To publish a new CLI version, run npm run release -- cli patch from the repository root (or use minor, major, or an explicit version). The release command validates the package before publishing it to the public npm registry.
For Ctrl+G prompt editing in Claude Code, Codex, Pi, or another CLI that uses the standard editor variables, configure EDITOR="writeme --wait" and VISUAL="$EDITOR" in the shell before launching that CLI. See the CLI guide for platform-specific examples.
How to develop
The project uses npm as the preferred package manager.
Android and iOS builds are available as GitHub Actions artifacts on main and are attached to new tagged releases alongside the desktop downloads. Android provides an installable debug APK; iOS provides an unsigned device IPA that requires signing before installation. See the mobile pipeline downloads for details, and the mobile package guide for setup and backup behavior.
- Clone the repository
- Install dependencies
npm install
- Start in development mode
-
For Electron:
npm run dev
-
For Browser/Web version:
npm run browser:dev
How to build
Build profiles
Store builds exclude restricted capabilities at build time. Direct desktop and Homebrew builds keep all features. See the build profiles and store policy audit for the capability matrix, build commands, and submission requirements.
npm run build:profile -- macos-homebrew package
npm run build:profile -- macos-app-store package
npm run build:profile -- ios-app-store sync
npm run build:profile -- android-google-play sync
Desktop (Electron)
To package the application for your current platform:
npm run build:package
To create distributables (e.g., .deb, .exe, .zip):
npm run make
Installing the DMG locally (macOS)
The build is ad-hoc signed, which satisfies Apple Silicon's code-signing requirement but is not notarized. macOS will quarantine the downloaded file and block the first launch. Clear the quarantine flag before opening:
# Build
npm run make -- --platform=darwin
# Clear quarantine from the DMG before mounting
xattr -dr com.apple.quarantine out/make/writeme.dmg
Open the DMG, drag writeme to /Applications, then clear quarantine from the installed app:
xattr -cr /Applications/writeme.app
The app will open normally from that point on.
以上為 README 的開頭部分。其餘內容請閱讀原文。 檢視完整 README ↗
