KIT-ILIAS-downloader/README.md

73 lines
2.1 KiB
Markdown

# KIT-ILIAS-downloader
Download content from ILIAS. That includes:
* files
* exercise sheets and solutions
* Opencast lectures
* forum posts (beta)
## Installation
Go to the [releases](../../releases) and get the executable for your operating system. Alternatively compile from source: (to get the latest updates)
```
$ git clone https://github.com/FliegendeWurst/KIT-ILIAS-downloader
$ cd KIT-ILIAS-downloader
$ cargo install --path .
```
## Usage
Use `-o <directory>` to specify the download directory. Username and password have to be provided every time the program is run.
Only content on your [personal desktop](https://ilias.studium.kit.edu/ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToSelectedItems) will be downloaded.
```
$ KIT-ILIAS-downloader --help
KIT-ILIAS-downloader 0.2.14
USAGE:
KIT-ILIAS-downloader [FLAGS] [OPTIONS] --output <output>
FLAGS:
--content-tree Use content tree (slow but thorough)
-f Re-download already present files
-t, --forum Download forum content
-h, --help Prints help information
-n, --no-videos Do not download Opencast videos
-s, --skip-files Do not download files
-V, --version Prints version information
-v Verbose logging (print objects downloaded)
OPTIONS:
-j, --jobs <jobs> Parallel download jobs [default: 1]
-o, --output <output> Output directory
-p, --proxy <proxy> Proxy, e.g. socks5h://127.0.0.1:1080 [default: ""]
```
### .iliasignore
.gitignore syntax can be used in a `.iliasignore` file: (located in the download folder)
```ignore
# example 1: only download a single course
/*/
!/InsertCourseHere/
# example 2: only download files related to one tutorial
/Course/Tutorien/*/
!/Course/Tutorien/Tut* 3/
```
### .iliaslogin
If you don't want to enter your credentials every time you run the program, you can instead save your username and password in a file (`.iliaslogin`):
```
username
password
```
## Similar programs
- https://github.com/brantsch/kit-ilias-fuse/
- https://github.com/Garmelon/PFERD/