This README is the one indexed from the repository at its latest ref, not from the tag for this version.

CatchUp

CatchUp is an ephemeral IRC logger and a mobile-friendly Web-based log viewer in a single binary. It was created for #tcl on freenode (and now Libera Chat), but it is written in Crystal. It understands IRC bridges, like the ijchain XMPP bridge and the ischain Slack bridge that operate on the channel. It only keeps logs for the last 48 hours. The goal is to let you catch up with the scrollback from your phone, not to keep a record forever.

CatchUp is more of a rough personal project open-sourced for convenience. You may run into problems if you use it for something other than I do.

CatchUp uses SQLite for storage. The database file is created in a subdirectory of the directory specified by the XDG_STATE_HOME environment variable or ~/.local/state/.

Screenshot

Building a static Linux binary

1. Install Podman or Docker and just on your developer machine.
2. Clone this repository.
3. Run one of the following commands:

# Podman
just static

# Docker
just --set container-cli docker static

Command-line options

Usage: catchup [options]
    -h, --help                       Show this help and exit
    -V, --version                    Print version and exit
    --host 127.0.0.1                 Host to bind to
    --port 8080                      Port to bind to
    --irc-uri 'ircs://irc.libera.chat/#tcl'
                                     IRC connection URI
    --nick CatchUpBot                IRC bot's nick
    --bridge '^i[js]chain'           Matching nicks are treated as bridges to other channels
    --table tcl                      Database table

License

MIT.