Programm zum Flotten, Einfachen Runterladen von Dateien
Go to file
2023-12-09 23:08:42 +01:00
.github/workflows Update github action versions 2023-03-22 00:10:54 +01:00
PFERD Fix video name deduplication 2023-12-09 23:08:42 +01:00
scripts Fix mypy complaining about missing type hints 2021-06-09 22:45:52 +02:00
.gitignore Add .idea to gitignore 2023-09-13 22:23:36 +02:00 Fix video name deduplication 2023-12-09 23:08:42 +01:00 Add default show-not-deleted option 2023-08-26 18:43:01 +02:00 Add script for releasing new versions 2021-05-24 20:23:14 +02:00
flake.lock Update flake.lock 2023-09-13 22:23:36 +02:00
flake.nix Add Nix flake 2023-08-26 23:54:19 +02:00
LICENSE Add no-delete-prompt-overwrite crawler conflict resolution option (#75) 2023-07-29 18:36:33 +02:00
mypy.ini Extend mypy config 2021-04-29 11:44:47 +02:00 Document why / exists 2021-05-25 13:31:29 +02:00
pyproject.toml Do project setup from scratch 2021-04-27 00:07:54 +02:00 Add more unofficial package managers (#66) 2022-11-04 12:18:26 +01:00
setup.cfg Increase minimum python version to 3.9 2022-04-27 22:52:50 +02:00


Programm zum Flotten, Einfachen Runterladen von Dateien

Other resources:


Direct download

Binaries for Linux, Windows and Mac can be downloaded directly from the latest release.

With pip

Ensure you have at least Python 3.9 installed. Run the following command to install PFERD or upgrade it to the latest version:

$ pip install --upgrade git+

The use of venv is recommended.

With package managers

Unofficial packages are available for:

See also PFERD's repology page.

Basic usage

PFERD can be run directly from the command line with no config file. Run pferd -h to get an overview of available commands and options. Run pferd <command> -h to see which options a command has.

For example, you can download your personal desktop from the KIT ILIAS like this:

$ pferd kit-ilias-web desktop <output_directory>

Also, you can download most ILIAS pages directly like this:

$ pferd kit-ilias-web <url> <output_directory>

However, the CLI only lets you download a single thing at a time, and the resulting command can grow long quite quickly. Because of this, PFERD can also be used with a config file.

To get started, just take a command you've been using and add --dump-config directly after pferd, like this:

$ pferd --dump-config kit-ilias-web <url> <output_directory>

This will make PFERD write its current configuration to its default config file path. You can then run pferd without a command and it will execute the config file. Alternatively, you can use --dump-config-to and specify a path yourself. Using --dump-config-to - will print the configuration to stdout instead of a file, which is a good way to see what is actually going on when using a CLI command.

Another good way to see what PFERD is doing is the --explain option. When enabled, PFERD explains in detail what it is doing and why. This can help with debugging your own config.

If you don't want to run all crawlers from your config file, you can specify the crawlers you want to run with --crawler or -C, like this:

$ pferd -C crawler1 -C crawler2

Advanced usage

PFERD supports lots of different options. For example, you can configure PFERD to use your system's keyring instead of prompting you for your username and password. PFERD also supports transformation rules that let you rename or exclude certain files.

For more details, see the comprehensive config format documentation.


This example downloads a few courses from the KIT ILIAS with a common keyring authenticator. It reorganizes and ignores some files.

# All paths will be relative to this.
# The crawler output directories will be <working_dir>/Foo and <working_dir>/Bar.
working_dir = ~/stud
# If files vanish from ILIAS the local files are not deleted, allowing us to
# take a look at them before deleting them ourselves.
on_conflict = no-delete

type = keyring
username = foo

type = kit-ilias-web
auth = auth:ilias
# Crawl a course by its ID (found as `ref_id=ID` in the URL)
target = 1234567

# Plaintext files are easier to read by other tools
links = plaintext

transform =
  # Ignore unneeded folders
  Online-Tests --> !
  Vorlesungswerbung --> !

  # Rename folders
  Lehrbücher --> Vorlesung
  # Note the ">>" arrow head which lets us apply further rules to files moved to "Übung"
  Übungsunterlagen -->> Übung

  # Move exercises to own folder. Rename them to "Blatt-XX.pdf" to make them sort properly
  "Übung/(\d+). Übungsblatt.pdf" -re-> Blätter/Blatt-{i1:02}.pdf
  # Move solutions to own folder. Rename them to "Blatt-XX-Lösung.pdf" to make them sort properly
  "Übung/(\d+). Übungsblatt.*Musterlösung.pdf" -re-> Blätter/Blatt-{i1:02}-Lösung.pdf

  # The course has nested folders with the same name - flatten them
  "Übung/(.+?)/\\1" -re-> Übung/{g1}

type = kit-ilias-web
auth = auth:ilias
target = 1337420