Skip to content

Repository files navigation

Clip Logo

Clip

A simple, cross-platform RSS reader — for macOS / Windows, built for fast browsing and distraction-free reading.

Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge

简体中文 | English

Screenshots

Clip screenshot 1 Clip screenshot 2

Features

  • Three-column layout: source/folder tree · article list · reading view
  • Subscription management: add feeds, organize into folders, OPML import/export
  • Scheduled fetching: RSS / Atom parsing with background auto-refresh
  • Focused reading: full-text reading view + distraction-free focus mode
  • Fast search: global full-text search across titles, summaries, and notes
  • Notes: attach notes to articles for later review
  • Desktop notifications: new-article alerts, macOS Dock / Windows taskbar badges
  • Keyboard driven: a complete set of shortcuts
  • Theme & i18n: light / dark / follow-system, Chinese & English
  • Performance & offline: lightweight list queries, local cache, readable offline

Building from Source

1. Prepare the Development Environment

Dependency Version Install
Go ≥ 1.25 https://go.dev/dl/
Node.js ≥ 20 https://nodejs.org/
pnpm ≥ 9 npm install -g pnpm
Wails v3 CLI latest go install github.com/wailsapp/wails/v3/cmd/wails3@latest

Platform-specific requirements:

  • macOS: install Xcode Command Line Tools — xcode-select --install
  • Windows: WebView2 Runtime (preinstalled on Windows 11)

2. Clone and Install Dependencies

# Clone the repository
git clone https://github.com/clip-rss/clip.git
cd clip

# Install frontend dependencies
cd frontend
pnpm install
cd ..

# Pull Go dependencies
go mod tidy

3. Development Mode (Hot Reload)

wails3 task dev

Starts the Vite dev server and Go backend; changes apply live.

4. Build & Package

# Build the binary for the current platform
wails3 task build

# Package a distributable installer (macOS → .app / Windows → installer)
wails3 task package

Artifacts are output to the bin/ directory.

5. Tests

# Go backend tests
go test ./...

# Frontend type check + unit tests
cd frontend
pnpm typecheck
pnpm test

Extra: Regenerate Frontend Bindings

After modifying bound methods or Go models under api/, regenerate the frontend TS bindings:

wails3 generate bindings

Do not hand-edit files under frontend/bindings/.

License

MIT

About

A simple, cross-platform RSS reader — for macOS / Windows, built for fast browsing and distraction-free reading. 简单好用的跨平台 RSS 阅读器 —— 支持 macOS / Windows,专注于快速浏览与阅读。

Topics

Resources

Stars

10 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages