RSS Guard

https://rssguard.readthedocs.io/en/stable
Admin
RSS Guard is an open-source, cross-platform desktop feed reader and podcast player that supports...
Tokens:40,984
Snippets:728
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Command execution examples for feed sources

Source: https://rssguard.readthedocs.io/en/stable/_sources/services/standard-sources.md.txt

Examples of commands used to generate or process feed data, utilizing the %data% placeholder for the user-data directory.

```text
bash "%data%/scripts/download-feed.sh"

python "%data%/scripts/build-feed.py"

%data%\jq.exe "{ version: \"1.1\", title: \"Stars\", items: . }"
```

--------------------------------

### Install and configure CSS2RSS

Source: https://rssguard.readthedocs.io/en/stable/_sources/troubleshooting/flatpak.md.txt

Commands to install dependencies, download the script, and manage the Flatpak SDK environment for CSS2RSS.

```sh
flatpak install org.freedesktop.Sdk//25.08
```

```sh
flatpak run --runtime=org.freedesktop.Sdk//25.08 --command=pip io.github.martinrotter.rssguard install beautifulsoup4 maya
```

```sh
flatpak run --command=curl io.github.martinrotter.rssguard https://raw.githubusercontent.com/Owyn/CSS2RSS/refs/heads/main/css2rss.py -o ~/.var/app/io.github.martinrotter.rssguard/config/rssguard5/css2rss.py
```

```sh
flatpak uninstall org.freedesktop.Sdk//25.08
```

--------------------------------

### Define ProcDump Extraction Path

Source: https://rssguard.readthedocs.io/en/stable/_sources/contrib/bugs.md.txt

Example path for extracting the ProcDump utility files.

```text
C:\Users\YOUR_USER_NAME\Downloads\Procdump
```

--------------------------------

### Generate Debug Log via Command Line

Source: https://rssguard.readthedocs.io/en/stable/contrib/bugs.html

Use the --debug and --log flags to capture detailed diagnostic information into a file. Ensure the application is closed before starting to capture the full session.

```bash
rssguard --debug --log "rssguard.log"
```

```bash
"%ProgramFiles%\RSS Guard\rssguard.exe" --debug --log "%USERPROFILE%\Desktop\rssguard.log"
```

```bash
rssguard.exe --debug --log "%USERPROFILE%\Desktop\rssguard.log"
```

```bash
rssguard --debug --log "$HOME/rssguard.log"
```

```bash
/Applications/RSSGuard.app/Contents/MacOS/rssguard --debug --log "$HOME/Desktop/rssguard.log"
```

```bash
rssguard --debug --log ""
```

--------------------------------

### Display RSS Guard CLI help

Source: https://rssguard.readthedocs.io/en/stable/features/cli.html

View available command-line options and usage instructions.

```text
Usage: rssguard [options] [url-1 ... url-n]
RSS Guard

Options:
  -h, --help                     Displays overview of CLI.
  -v, --version                  Displays version of the application.
  -d, --data <user-data-folder>  Use custom folder for user data and disable
                                 single instance application mode.
  -s, --no-single-instance       Allow running of multiple application
                                 instances.
  -g, --debug                    Enable "debug" CLI output.
  -l, --log <log-file-name>      Log application standard/error output to file.
                                 When empty string is provided as argument, then
                                 the log file will be stored in user data
                                 folder.
  -t, --style <style-name>       Force some application style.
  -u, --user-agent <user-agent>  User custom User-Agent HTTP header for all
                                 network requests. This option takes precedence
                                 over User-Agent set via application settings.
  --threads <count>              Specify number of threads. Note that number
                                 cannot be higher than 32.

Arguments:
  urls                           List of URL addresses pointing to individual
                                 online feeds which should be added.
```

--------------------------------

### Display CLI Help

Source: https://rssguard.readthedocs.io/en/stable/_sources/features/cli.md.txt

Run this command in your terminal to view all available CLI options and arguments.

```bash
rssguard --help
```

--------------------------------

### Example JSON custom_data structure

Source: https://rssguard.readthedocs.io/en/stable/_sources/contrib/migrate.md.txt

Represents the serialized JSON format used for storing account-specific feed metadata in the 4.x database schema.

```json
{
  "encoding": "UTF-8",
  "password": "AwUujeO2efOgYpX3g1/zoOTp9JULcLTZzwfY",
  "post_process": "",
  "protected": false,
  "source_type": 0,
  "type": 3,
  "username": ""
}
```

--------------------------------

### fs.runExecutableGetOutput

Source: https://rssguard.readthedocs.io/en/stable/_sources/features/filters.md.txt

Launches an external executable and returns its standard output.

```APIDOC
## runExecutableGetOutput(String exec, Array<String> params, String stdin_data, String working_directory)

### Description
Launches an external executable, waits for it to finish, and returns its standard output as text.

### Parameters
- **exec** (String) - The executable path.
- **params** (Array<String>) - Command line arguments.
- **stdin_data** (String) - Data to pass to standard input.
- **working_directory** (String) - The working directory for the process.

### Return Value
- **String** - The standard output of the executable.
```

--------------------------------

### fs.runExecutable

Source: https://rssguard.readthedocs.io/en/stable/_sources/features/filters.md.txt

Launches an external executable without waiting for it to finish.

```APIDOC
## runExecutable(String exec, Array<String> params, String stdin_data, String working_directory)

### Description
Launches an external executable with optional parameters, standard input, and working directory, without waiting for it to finish.

### Parameters
- **exec** (String) - The executable path.
- **params** (Array<String>) - Command line arguments.
- **stdin_data** (String) - Data to pass to standard input.
- **working_directory** (String) - The working directory for the process.
```

--------------------------------

### Use a SOCKS5 proxy with authentication

Source: https://rssguard.readthedocs.io/en/stable/_sources/features/extractor.md.txt

Configures a SOCKS5 proxy with username and password authentication.

```bash
printf '{"proxy":{"type":"socks5","address":"127.0.0.1:1080","username":"user","password":"pass"}}' \
  | rssguard-article-extractor "https://example.com/article"
```

--------------------------------

### Use enclosure as URL

Source: https://rssguard.readthedocs.io/en/stable/_sources/features/filters.md.txt

Promotes the first enclosure URL to the main article URL.

```javascript
/*
 * Turn the first enclosure into the main article URL.
 */
function filterMessage() {
  if (msg.enclosures.length > 0) {
    msg.url = msg.enclosures[0].url;
    msg.removeEnclosure(0);
  }

  return Msg.Accept;
}
```

--------------------------------

### Grant autostart directory access

Source: https://rssguard.readthedocs.io/en/stable/_sources/troubleshooting/flatpak.md.txt

Allows RSS Guard to write to the autostart directory for system startup functionality.

```sh
flatpak override --user --filesystem=xdg-config/autostart io.github.martinrotter.rssguard
```

--------------------------------

### Run ProcDump for Crash Monitoring

Source: https://rssguard.readthedocs.io/en/stable/_sources/contrib/bugs.md.txt

Commands to initiate ProcDump monitoring for RSS Guard crashes.

```batch
procdump64.exe -accepteula -e -mm -n 1 -w rssguard.exe "%USERPROFILE%\Desktop\rssguard-dumps"
```

```batch
procdump.exe -accepteula -e -mm -n 1 -w rssguard.exe "%USERPROFILE%\Desktop\rssguard-dumps"
```

--------------------------------

### Use existing HTML instead of downloading

Source: https://rssguard.readthedocs.io/en/stable/_sources/features/extractor.md.txt

Processes a provided HTML string directly instead of fetching content from the URL.

```bash
printf '{"html":"<!doctype html><html><body><article><h1>Hello</h1><p>Body.</p></article></body></html>"}' \
  | rssguard-article-extractor "https://example.com/article"
```

```powershell
'{"html":"<!doctype html><html><body><article><h1>Hello</h1><p>Body.</p></article></body></html>"}' |
  rssguard-article-extractor "https://example.com/article"
```

--------------------------------

### Generate Debug Log via Command Line

Source: https://rssguard.readthedocs.io/en/stable/_sources/contrib/bugs.md.txt

Standard command to launch RSS Guard with debug logging enabled and output directed to a file.

```bash
rssguard --debug --log "rssguard.log"
```

```bash
rssguard --debug --log "rssguard.log"
```

```batch
"%ProgramFiles%\RSS Guard\rssguard.exe" --debug --log "%USERPROFILE%\Desktop\rssguard.log"
```

```batch
rssguard.exe --debug --log "%USERPROFILE%\Desktop\rssguard.log"
```

```bash
rssguard --debug --log "$HOME/rssguard.log"
```

```bash
/Applications/RSSGuard.app/Contents/MacOS/rssguard --debug --log "$HOME/Desktop/rssguard.log"
```

```bash
rssguard --debug --log ""
```

--------------------------------

### fs

Source: https://rssguard.readthedocs.io/en/stable/features/filters.html

File system and external process execution functions.

```APIDOC
## fs.runExecutable(String exec, Array<String> params, String stdin_data, String working_directory)

### Description
Launches an external executable without waiting for it to finish.

## fs.runExecutableGetOutput(String exec, Array<String> params, String stdin_data, String working_directory)

### Description
Launches an external executable, waits for it to finish, and returns its standard output as text.
```

--------------------------------

### Execute Article Extractor via Command Line

Source: https://rssguard.readthedocs.io/en/stable/_sources/features/extractor.md.txt

Basic command line usage for the extractor tool, requiring a URL as the primary argument.

```text
rssguard-article-extractor [options] <url>
```

--------------------------------

### Use an HTTP proxy

Source: https://rssguard.readthedocs.io/en/stable/_sources/features/extractor.md.txt

Configures an HTTP proxy for the extraction request.

```bash
printf '{"proxy":{"type":"http","address":"127.0.0.1:8080"}}' \
  | rssguard-article-extractor "https://example.com/article"
```

--------------------------------

### Configure Extra XMPP Nodes

Source: https://rssguard.readthedocs.io/en/stable/_sources/services/xmpp.md.txt

Specify additional PubSub services, XMPP accounts, or chat rooms by adding one address per line in the Extra nodes configuration.

```text
news.movim.eu
person@example.org
room@conference.example.org
```

--------------------------------

### Custom Skin Directory Path

Source: https://rssguard.readthedocs.io/en/stable/features/skins.html

The directory structure for a custom skin named 'greenland' within the user-data path.

```text
<user-data-path>\skins\greenland

```

--------------------------------

### Open Command Prompt

Source: https://rssguard.readthedocs.io/en/stable/_sources/contrib/bugs.md.txt

Command to open a terminal window from the File Explorer address bar.

```text
cmd
```

--------------------------------

### Navigate to ProcDump Directory

Source: https://rssguard.readthedocs.io/en/stable/_sources/contrib/bugs.md.txt

Command to change the working directory to the ProcDump folder in an elevated Command Prompt.

```batch
cd /d "%USERPROFILE%\Downloads\Procdump"
```

--------------------------------

### Application Functions

Source: https://rssguard.readthedocs.io/en/stable/_sources/features/filters.md.txt

Functions for logging and user notifications.

```APIDOC
## app Functions

- `log(String message)`: Prints a message to the log and script output box.
- `showNotification(String title, String text)`: Displays a desktop notification.
```

--------------------------------

### Create Crash Dump Directory

Source: https://rssguard.readthedocs.io/en/stable/_sources/contrib/bugs.md.txt

Folder name to create on the Desktop for storing generated crash dump files.

```text
rssguard-dumps
```

--------------------------------

### utils

Source: https://rssguard.readthedocs.io/en/stable/features/filters.html

Utility functions for data conversion and file operations.

```APIDOC
## utils.fromXmlToJson(String xml_string)

### Description
Converts an XML string into JSON.

## utils.readFile(String filename)

### Description
Reads a file into a byte array.

## utils.writeFile(String filename, ArrayBuffer data)

### Description
Writes a byte array to a file.

## utils.readTextFile(String filename)

### Description
Reads a text file as UTF-8.

## utils.writeTextFile(String filename, String text)

### Description
Writes text as UTF-8.

## utils.parseDateTime(String date_time)

### Description
Converts a textual date/time representation into a proper Date object.
```

--------------------------------

### Convert HTML to Plain Text via Pandoc

Source: https://rssguard.readthedocs.io/en/stable/_sources/features/filters.md.txt

Invokes an external Pandoc binary located in the user-data directory to convert HTML content.

```javascript
/*
 * Convert article contents from HTML to plain text with Pandoc.
 *
 * This uses a Pandoc binary placed directly in the user-data folder.
 */
function filterMessage() {
  let res = fs.runExecutableGetOutput(
      '%data%\\pandoc.exe',
      ['-f', 'html', '-t', 'plain'],
      msg.contents);

  msg.contents = res;

  return Msg.Accept;
}
```
Tokens:
Raw