izrss

command module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 8, 2025 License: GPL-3.0 Imports: 9 Imported by: 0

README

izrss

An RSS feed reader for the terminal.

 

demo

Usage & Customization

The main bulk of customization is done via the ~/.config/izrss/config.toml file. You can find an example file here config.toml.

The rest of the config is done via using the environment variables GLAMOUR_STYLE. For a good example see: catppuccin/glamour

Then run izrss to read the feeds.

Installation

With Nix flakes and home-manager

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";

    home-manager = {
      url = "github:nix-community/home-manager";
      inputs.nixpkgs.follows = "nixpkgs";
    };

    izrss.url = "github:isabelroses/izrss";
  };

  outputs = { self, nixpkgs, home-manager, izrss }: {
    homeConfigurations."user@hostname" = home-manager.lib.homeManagerConfiguration {
      modules = [
        home-manager.homeManagerModules.default
        izrss.homeManagerModules.default
        {
          programs.izrss = {
            enable = true;
            settings.urls = [
              "https://isabelroses.com/rss.xml"
              "https://uncenter.dev/feed.xml"
            ];
          };
        }
      ];
    };
  }
}

With Nix flakes

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    izrss.url = "github:isabelroses/izrss";
  };

  outputs = { self, nixpkgs, izrss }: {
    nixosConfigurations.example = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [{
        environment.systemPackages = [
          inputs.izrss.packages.${pkgs.system}.default
        ];
      }];
    };
  }
}

Documentation

Overview

Package main is the entry point for the izrss application

Directories

Path Synopsis
internal
config
Package config handles application configuration
Package config handles application configuration
rss
Package rss handles RSS feed fetching and parsing
Package rss handles RSS feed fetching and parsing
storage
Package storage handles data persistence using SQLite
Package storage handles data persistence using SQLite
ui
Package ui provides the terminal user interface for izrss
Package ui provides the terminal user interface for izrss

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL