Skip to content
Back to search

clawfeed

SkillWorks with Claude CodeGitHub

ClawFeed — AI-powered news digest with structured summaries from Twitter/RSS feeds and web dashboard

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/kevinho--clawfeed/badge.svg)](/listings/kevinho--clawfeed)

HTML

<a href="/listings/kevinho--clawfeed"><img src="/api/listings/kevinho--clawfeed/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Option 1: ClawHub (recommended)

clawhub install clawfeed

Option 2: OpenClaw Skill

cd ~/.openclaw/skills/
git clone https://github.com/kevinho/clawfeed.git

OpenClaw auto-detects `SKILL.md` and loads the skill. The agent can then generate digests via cron, serve the dashboard, and handle bookmark commands.

Option 3: Zylos Skill

cd ~/.zylos/skills/
git clone https://github.com/kevinho/clawfeed.git

Option 4: Standalone

git clone https://github.com/kevinho/clawfeed.git
cd clawfeed
npm install

Option 5: Docker

# Basic usage
docker run -d -p 8767:8767 kevinho/clawfeed

# With persistent data
docker run -d -p 8767:8767 -v clawfeed-data:/app/data kevinho/clawfeed

# With environment variables (recommended for production)
docker run -d -p 8767:8767 \
  -v clawfeed-data:/app/data \
  -e ALLOWED_ORIGINS=https://yourdomain.com \
  -e API_KEY=your-api-key \
  -e GOOGLE_CLIENT_ID=your-client-id \
  -e GOOGLE_CLIENT_SECRET=your-client-secret \
  -e SESSION_SECRET=your-session-secret \
  kevinho/clawfeed

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

SKILL.md · Manifest · 91 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # ClawFeed
  2. AI-powered news digest tool. Automatically generates structured summaries (4H/daily/weekly/monthly) from Twitter and RSS feeds.
  3. ## Credentials & Dependencies
  4. ClawFeed runs in **read-only mode** with zero credentials — browse digests, view feeds, switch languages. Authentication features (bookmarks, sources, packs) require additional credentials.
  5. | Credential | Purpose | Required |
  6. |-----------|---------|----------|
  7. | `GOOGLE_CLIENT_ID` | Google OAuth login | For auth features |
  8. | `GOOGLE_CLIENT_SECRET` | Google OAuth login | For auth features |
  9. | `SESSION_SECRET` | Session cookie encryption | For auth features |
  10. | `API_KEY` | Digest creation endpoint protection | For write API |
  11. **Runtime dependency:** SQLite via `better-sqlite3` (native addon, bundled). No external database server required.
  12. ## Setup
  13. ```bash
  14. # Install dependencies
  15. npm install
  16. # Copy environment config
  17. cp .env.example .env
  18. # Edit .env with your settings
  19. # Start API server
  20. npm start
  21. ```
  22. ## Environment Variables
  23. Configure in `.env` file:
  24. | Variable | Description | Required | Default |
  25. |----------|-------------|----------|---------|
  26. | `DIGEST_PORT` | Server port | No | 8767 |
  27. | `GOOGLE_CLIENT_ID` | Google OAuth client ID | For auth | - |
  28. | `GOOGLE_CLIENT_SECRET` | Google OAuth client secret | For auth | - |
  29. | `SESSION_SECRET` | Session cookie encryption key | For auth | - |
  30. | `API_KEY` | Digest creation API key | For write API | - |
  31. | `AI_DIGEST_DB` | SQLite database path | No | `data/digest.db` |
  32. | `ALLOWED_ORIGINS` | CORS allowed origins | No | localhost |
  33. ## API Server
  34. Runs on port `8767` by default. Set `DIGEST_PORT` env to change.
  35. ### Endpoints
  36. | Method | Path | Description | Auth |
  37. |--------|------|-------------|------|
  38. | GET | /api/digests | List digests (?type=4h\|daily\|weekly&limit=20&offset=0) | - |
  39. | GET | /api/digests/:id | Get single digest | - |
  40. | POST | /api/digests | Create digest (internal) | - |
  41. | GET | /api/auth/google | Start Google OAuth flow | - |
  42. | GET | /api/auth/callback | OAuth callback endpoint | - |
  43. | GET | /api/auth/me | Get current user info | Yes |
  44. | POST | /api/auth/logout | Logout user | Yes |
  45. | GET | /api/marks | List user bookmarks | Yes |
  46. | POST | /api/marks | Add bookmark | Yes |
  47. | DELETE | /api/marks/:id | Remove bookmark | Yes |
  48. | GET | /api/config | Get configuration | - |
  49. | PUT | /api/config | Update configuration | - |
  50. ## Web Dashboard
  51. Serve `web/index.html` via your reverse proxy or any static file server.
  52. ## Templates
  53. - `templates/curation-rules.md` — Customize feed curation rules
  54. - `templates/digest-prompt.md` — Customize the AI summarization prompt
  55. ## Configuration
  56. Copy `config.example.json` to `config.json` and edit. See README for details.
  57. ## Reverse Proxy (Caddy example)
  58. ```
  59. handle /digest/api/* {
  60. uri strip_prefix /digest/api
  61. reverse_proxy localhost:8767
  62. }
  63. handle_path /digest/* {
  64. root * /path/to/clawfeed/web
  65. file_server
  66. }
  67. ```
README.md · README · 252 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # ClawFeed
  2. > **Stop scrolling. Start knowing.**
  3. [![ClawHub](https://img.shields.io/badge/ClawHub-clawfeed-blue)](https://clawhub.ai/skills/clawfeed)
  4. [![GitHub](https://img.shields.io/github/v/tag/kevinho/clawfeed?label=version)](https://github.com/kevinho/clawfeed)
  5. [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
  6. [Live Demo: https://clawfeed.kevinhe.io](https://clawfeed.kevinhe.io)
  7. AI-powered news digest that curates thousands of sources down to the highlights that matter. Generates structured summaries (4H/daily/weekly/monthly) from Twitter, RSS, and more. Works standalone or as an [OpenClaw](https://github.com/openclaw/openclaw) / [Zylos](https://github.com/zylos-ai) skill.
  8. ![Dashboard](docs/demo.gif)
  9. ## Features
  10. - 📰 **Multi-frequency digests** — 4-hourly, daily, weekly, monthly summaries
  11. - 📡 **Sources system** — Add Twitter feeds, RSS, HackerNews, Reddit, GitHub Trending, and more
  12. - 📦 **Source Packs** — Share curated source bundles with the community
  13. - 📌 **Mark & Deep Dive** — Bookmark content for AI-powered deep analysis
  14. - 🎯 **Smart curation** — Configurable rules for content filtering and noise reduction
  15. - 👀 **Follow/Unfollow suggestions** — Based on feed quality analysis
  16. - 📢 **Feed output** — Subscribe to any user's digest via RSS or JSON Feed
  17. - 🌐 **Multi-language** — English and Chinese UI
  18. - 🌙 **Dark/Light mode** — Theme toggle with localStorage persistence
  19. - 🖥️ **Web dashboard** — SPA for browsing and managing digests
  20. - 💾 **SQLite storage** — Fast, portable, zero-config database
  21. - 🔐 **Google OAuth** — Multi-user support with personal bookmarks and sources
  22. ## Installation
  23. ### Option 1: ClawHub (recommended)
  24. ```bash
  25. clawhub install clawfeed
  26. ```
  27. ### Option 2: OpenClaw Skill
  28. ```bash
  29. cd ~/.openclaw/skills/
  30. git clone https://github.com/kevinho/clawfeed.git
  31. ```
  32. OpenClaw auto-detects `SKILL.md` and loads the skill. The agent can then generate digests via cron, serve the dashboard, and handle bookmark commands.
  33. ### Option 3: Zylos Skill
  34. ```bash
  35. cd ~/.zylos/skills/
  36. git clone https://github.com/kevinho/clawfeed.git
  37. ```
  38. ### Option 4: Standalone
  39. ```bash
  40. git clone https://github.com/kevinho/clawfeed.git
  41. cd clawfeed
  42. npm install
  43. ```
  44. ### Option 5: Docker
  45. ```bash
  46. # Basic usage
  47. docker run -d -p 8767:8767 kevinho/clawfeed
  48. # With persistent data
  49. docker run -d -p 8767:8767 -v clawfeed-data:/app/data kevinho/clawfeed
  50. # With environment variables (recommended for production)
  51. docker run -d -p 8767:8767 \
  52. -v clawfeed-data:/app/data \
  53. -e ALLOWED_ORIGINS=https://yourdomain.com \
  54. -e API_KEY=your-api-key \
  55. -e GOOGLE_CLIENT_ID=your-client-id \
  56. -e GOOGLE_CLIENT_SECRET=your-client-secret \
  57. -e SESSION_SECRET=your-session-secret \
  58. kevinho/clawfeed
  59. ```
  60. ## Quick Start
  61. ```bash
  62. # 1. Copy and edit environment config
  63. cp .env.example .env
  64. # Edit .env with your settings
  65. # 2. Start the API server
  66. npm start
  67. # → API running on http://127.0.0.1:8767
  68. ```
  69. ## Environment Variables
  70. Create a `.env` file in the project root:
  71. | Variable | Description | Required | Default |
  72. |----------|-------------|----------|---------|
  73. | `GOOGLE_CLIENT_ID` | Google OAuth client ID | No* | - |
  74. | `GOOGLE_CLIENT_SECRET` | Google OAuth client secret | No* | - |
  75. | `SESSION_SECRET` | Session encryption key | No* | - |
  76. | `API_KEY` | API key for digest creation | No | - |
  77. | `DIGEST_PORT` | Server port | No | 8767 |
  78. | `ALLOWED_ORIGINS` | Allowed origins for CORS | No | localhost |
  79. \*Required for authentication features. Without OAuth, the app runs in read-only mode.
  80. ## Authentication Setup
  81. To enable Google OAuth login:
  82. 1. Go to [Google Cloud Console](https://console.cloud.google.com/)
  83. 2. Create a new project or select existing one
  84. 3. Enable the Google+ API
  85. 4. Create OAuth 2.0 credentials
  86. 5. Add your domain to authorized origins
  87. 6. Add callback URL: `https://yourdomain.com/api/auth/callback`
  88. 7. Set credentials in `.env`
  89. ## API
  90. All endpoints prefixed with `/api/`.
  91. ### Digests
  92. | Method | Endpoint | Description | Auth |
  93. |--------|----------|-------------|------|
  94. | `GET` | `/api/digests` | List digests `?type=4h&limit=20&offset=0` | - |
  95. | `GET` | `/api/digests/:id` | Get single digest | - |
  96. | `POST` | `/api/digests` | Create digest | API Key |
  97. ### Auth
  98. | Method | Endpoint | Description | Auth |
  99. |--------|----------|-------------|------|
  100. | `GET` | `/api/auth/config` | Auth availability check | - |
  101. | `GET` | `/api/auth/google` | Start OAuth flow | - |
  102. | `GET` | `/api/auth/callback` | OAuth callback | - |
  103. | `GET` | `/api/auth/me` | Current user info | Yes |
  104. | `POST` | `/api/auth/logout` | Logout | Yes |
  105. ### Marks (Bookmarks)
  106. | Method | Endpoint | Description | Auth |
  107. |--------|----------|-------------|------|
  108. | `GET` | `/api/marks` | List bookmarks | Yes |
  109. | `POST` | `/api/marks` | Add bookmark `{ url, title?, note? }` | Yes |
  110. | `DELETE` | `/api/marks/:id` | Remove bookmark | Yes |
  111. ### Sources
  112. | Method | Endpoint | Description | Auth |
  113. |--------|----------|-------------|------|
  114. | `GET` | `/api/sources` | List user's sources | Yes |
  115. | `POST` | `/api/sources` | Create source `{ name, type, config }` | Yes |
  116. | `PUT` | `/api/sources/:id` | Update source | Yes |
  117. | `DELETE` | `/api/sources/:id` | Soft-delete source | Yes |
  118. | `GET` | `/api/sources/detect` | Auto-detect source type from URL | Yes |
  119. ### Source Packs
  120. | Method | Endpoint | Description | Auth |
  121. |--------|----------|-------------|------|
  122. | `GET` | `/api/packs` | Browse public packs | - |
  123. | `POST` | `/api/packs` | Create pack from your sources | Yes |
  124. | `POST` | `/api/packs/:id/install` | Install pack (subscribe to its sources) | Yes |
  125. ### Feeds
  126. | Method | Endpoint | Description | Auth |
  127. |--------|----------|-------------|------|
  128. | `GET` | `/feed/:slug` | User's digest feed (HTML) | - |
  129. | `GET` | `/feed/:slug.json` | JSON Feed format | - |
  130. | `GET` | `/feed/:slug.rss` | RSS format | - |
  131. ### Config
  132. | Method | Endpoint | Description | Auth |
  133. |--------|----------|-------------|------|
  134. | `GET` | `/api/changelog` | Changelog `?lang=zh\|en` | - |
  135. | `GET` | `/api/roadmap` | Roadmap `?lang=zh\|en` | - |
  136. ## Reverse Proxy
  137. Example Caddy configuration:
  138. ```caddyfile
  139. handle /digest/api/* {
  140. uri strip_prefix /digest/api
  141. reverse_proxy localhost:8767
  142. }
  143. handle_path /digest/* {
  144. root * /path/to/clawfeed/web
  145. file_server
  146. }
  147. ```
  148. ## Customization
  149. - **Curation rules**: Edit `templates/curation-rules.md` to control content filtering
  150. - **Digest format**: Edit `templates/digest-prompt.md` to customize AI output format
  151. ## Source Types
  152. | Type | Example | Description |
  153. |------|---------|-------------|
  154. | `twitter_feed` | `@karpathy` | Twitter/X user feed |
  155. | `twitter_list` | List URL | Twitter list |
  156. | `rss` | Any RSS/Atom URL | RSS feed |
  157. | `hackernews` | HN Front Page | Hacker News |
  158. | `reddit` | `/r/MachineLearning` | Subreddit |
  159. | `github_trending` | `language=python` | GitHub trending repos |
  160. | `website` | Any URL | Website scraping |
  161. | `digest_feed` | ClawFeed user slug | Another user's digest |
  162. | `custom_api` | JSON endpoint | Custom API |
  163. ## Development
  164. ```bash
  165. npm run dev # Start with --watch for auto-reload
  166. ```
  167. ### Testing
  168. ```bash
  169. cd test
  170. ./setup.sh # Create test users
  171. ./e2e.sh # Run 66 E2E tests
  172. ./teardown.sh # Clean up
  173. ```
  174. ## Architecture
  175. See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for multi-tenant design and scale analysis.
  176. ## Roadmap
  177. See [ROADMAP.md](ROADMAP.md) or the in-app roadmap page.
  178. ## Contributing
  179. 1. Fork the repository
  180. 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
  181. 3. Commit your changes (`git commit -m 'Add some amazing feature'`)
  182. 4. Push to the branch (`git push origin feature/amazing-feature`)
  183. 5. Open a Pull Request
  184. ## License
  185. MIT License — see [LICENSE](LICENSE) for details.
  186. Copyright 2026 Kevin He

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.