2022-08-20 20:27:33 +02:00
|
|
|
# prose_dl
|
2023-02-07 15:30:05 +01:00
|
|
|
|
2022-08-20 20:27:33 +02:00
|
|
|
Helper to download all posts from prose.sh instance
|
|
|
|
|
2023-02-07 15:30:05 +01:00
|
|
|
[![dependency status](https://deps.rs/repo/gitea/git.mylloon.fr/Anri/prose_dl/status.svg)](https://deps.rs/repo/gitea/git.mylloon.fr/Anri/prose_dl)
|
2022-08-21 12:43:06 +02:00
|
|
|
|
2022-08-20 20:31:00 +02:00
|
|
|
## Installation
|
2023-02-07 15:30:05 +01:00
|
|
|
|
2022-08-20 20:31:00 +02:00
|
|
|
Clone the repo and get in
|
2023-02-07 15:30:05 +01:00
|
|
|
|
2022-08-20 20:31:00 +02:00
|
|
|
```bash
|
2023-02-07 15:30:05 +01:00
|
|
|
git clone https://git.mylloon.fr/Anri/prose_dl.git && cd prose_dl
|
2022-08-20 20:31:00 +02:00
|
|
|
```
|
2023-02-07 15:30:05 +01:00
|
|
|
|
2022-08-20 20:31:00 +02:00
|
|
|
Then install it
|
2023-02-07 15:30:05 +01:00
|
|
|
|
2022-08-20 20:31:00 +02:00
|
|
|
```bash
|
|
|
|
cargo install --path .
|
|
|
|
```
|
|
|
|
|
2022-08-20 20:27:33 +02:00
|
|
|
## Usage
|
2023-02-07 15:30:05 +01:00
|
|
|
|
2022-08-20 20:27:33 +02:00
|
|
|
Will download all your posts from [`prose.sh`](https://prose.sh/) into a
|
|
|
|
folder named after your username:
|
2023-02-07 15:30:05 +01:00
|
|
|
|
2022-08-20 20:27:33 +02:00
|
|
|
```bash
|
2022-08-20 20:31:00 +02:00
|
|
|
$ prose_dl <username>
|
2022-08-20 20:27:33 +02:00
|
|
|
```
|
|
|
|
|
2022-08-21 16:31:14 +02:00
|
|
|
Will download the special files too:
|
2023-02-07 15:30:05 +01:00
|
|
|
|
2022-08-21 16:31:14 +02:00
|
|
|
```bash
|
|
|
|
$ prose_dl -s <username>
|
|
|
|
```
|
|
|
|
|
2022-08-20 20:27:33 +02:00
|
|
|
More info with the `--help` option.
|
2022-08-21 17:12:05 +02:00
|
|
|
|
|
|
|
## FAQ
|
2023-02-07 15:30:05 +01:00
|
|
|
|
|
|
|
> Can this download unlisted posts (thoses with _date metadata_ set in the future)?
|
|
|
|
|
2022-08-21 17:12:05 +02:00
|
|
|
- No.
|
|
|
|
|
|
|
|
> Can this download specials files?
|
2023-02-07 15:30:05 +01:00
|
|
|
|
2022-08-21 17:12:05 +02:00
|
|
|
- Yes, with `-s` option
|
|
|
|
|
|
|
|
> Can I use a custom domain?
|
2023-02-07 15:30:05 +01:00
|
|
|
|
2022-08-21 17:12:05 +02:00
|
|
|
- Yes, with `--domain` option
|