Feed on Atom/RSS, evolve, output, like the Tutatara does
OCaml 92.5%
Perl 4.9%
Dune 0.9%
Other 1.7%
9 1 0

Clone this repository

https://tangled.org/anil.recoil.org/tuatara https://tangled.org/did:plc:nhyitepp3u4u6fcfboegzcjw/tuatara
git@git.recoil.org:anil.recoil.org/tuatara git@git.recoil.org:did:plc:nhyitepp3u4u6fcfboegzcjw/tuatara

For self-hosted knots, clone URLs may differ based on your setup.

Download tar.gz
README.md

Tuatara - Feed Aggregator#

Tuatara is a CLI tool for managing and aggregating web feeds. It supports Atom, RSS 1.0/2.0, and JSONFeed formats for input, stores posts in a local SQLite database, and can output unified feeds in Atom, JSONFeed, or HTML formats.

Key Features#

  • Multi-format support: Reads Atom, RSS 1.0/2.0, and JSONFeed formats
  • Unified output: Generates Atom, JSONFeed, or standalone HTML feeds
  • Local storage: SQLite database for efficient post management
  • TOML configuration: Flexible configuration with multiple output profiles
  • Sortal integration: Import feed sources from Sortal contact database
  • Conditional fetching: HTTP ETag and If-Modified-Since support for efficient updates

Usage#

# Initialize configuration
tuatara init

# Add a feed source
tuatara add https://example.com/feed.xml

# Fetch all sources
tuatara fetch

# List posts
tuatara posts

# Generate output feed
tuatara output --format atom --output feed.xml

# Show statistics
tuatara stats

Configuration#

Tuatara uses a TOML configuration file stored in $XDG_CONFIG_HOME/tuatara/config.toml:

[settings]
data_dir = "~/.local/share/tuatara"

[[outputs]]
name = "main"
format = "atom"
path = "output/feed.xml"
title = "My Aggregated Feed"

Commands#

  • init - Create initial configuration file
  • add <url> - Add a feed source
  • remove <url> - Remove a feed source
  • list - List all configured sources
  • fetch - Fetch posts from all sources
  • posts - List stored posts
  • output - Generate output feed
  • generate - Generate configured outputs from config file
  • stats - Show database statistics
  • import-sortal - Import feeds from Sortal contact database

Installation#

opam install tuatara

Documentation#

API documentation is available via:

opam install tuatara
odig doc tuatara

License#

ISC