This repository has been archived on 2023-04-26. You can view files and clone it, but cannot push or open issues or pull requests.
prose_dl/README.md

39 lines
863 B
Markdown
Raw Normal View History

2022-08-20 20:27:33 +02:00
# prose_dl
Helper to download all posts from prose.sh instance
2022-08-21 12:43:06 +02:00
[![dependency status](https://deps.rs/repo/gitea/git.kennel.ml/Anri/prose_dl/status.svg)](https://deps.rs/repo/gitea/git.kennel.ml/Anri/prose_dl)
2022-08-20 20:31:00 +02:00
## Installation
Clone the repo and get in
```bash
git clone https://git.kennel.ml/Anri/prose_dl.git && cd prose_dl
```
Then install it
```bash
cargo install --path .
```
2022-08-20 20:27:33 +02:00
## Usage
Will download all your posts from [`prose.sh`](https://prose.sh/) into a
folder named after your username:
```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:
```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
> Can this download unlisted posts (thoses with *date metadata* set in the future)?
- No.
> Can this download specials files?
- Yes, with `-s` option
> Can I use a custom domain?
- Yes, with `--domain` option