Skip to content

ChatRSS Documentation

ChatRSS is an RSS / RSSHub-first agent trigger tool. It normalizes feeds, notifications, community messages, and code-hosting events into Events, then routes them through Router, Model, Action, and Ledger stages.

Site: https://arch.gh.wzhecnu.cn/ChatRSS/

Choose by scenario

Scenario Documentation
Run the local flow quickly Quick start
Inspect current and target commands CLI tree
Check what ChatRSS owns Capability map
Map CLI commands to Python APIs Interface tree
Understand Trigger / Schema / Router / Model / Action / Ledger Trigger-Router-Action design
Pick a real platform trigger practice Real platform practice plan
Review a real platform loop Real-world cases / Zulip / Discourse / Mattermost / Zulip @mention quick start

Documentation sections

  • Getting started

Install locally, run flow demo, inspect RSSHub feed watching, and understand the RSSHub server boundary.

  • Commands and interfaces

ChatTea-style CLI tree, target minor-version tree, capability map, and Python interface mapping.

  • Architecture

Durable Trigger -> Event Schema -> Router -> Model -> Action -> Ledger abstraction.

  • Practice

Zulip, Discourse, and Mattermost are verified real trigger/action cases. Mattermost should use the direct gateway for realtime agent rooms; ChatRSS is the optional shared router/ledger layer.

Current safety defaults

  • Triggers discover and normalize events; they do not execute external actions directly.
  • repo_event is archived as background context by default.
  • External writes default to dry_run, draft, or approval_required.
  • Ledgers record events, decisions, actions, and results, not tokens, passwords, or API keys.

Local preview

python -m pip install -e ".[docs]"
mkdocs serve