mirror of
https://github.com/NohamR/papeer.git
synced 2026-05-25 04:17:19 +00:00
67 lines
1.7 KiB
Markdown
67 lines
1.7 KiB
Markdown
# Installation
|
|
|
|
## From binary
|
|
|
|
```sh
|
|
curl https://github.com/lapwat/papeer/releases/download/v0.0.1/papeer-v0.0.1 > papeer
|
|
chmod +x papeer
|
|
mv papeer /usr/local/bin
|
|
```
|
|
|
|
## From source
|
|
|
|
```sh
|
|
go install github.com/lapwat/papeer
|
|
```
|
|
|
|
# Usage
|
|
|
|
```txt
|
|
Browse the web in the eink era
|
|
|
|
Usage:
|
|
papeer [flags]
|
|
papeer [command]
|
|
|
|
Available Commands:
|
|
completion generate the autocompletion script for the specified shell
|
|
get Scrape URL content
|
|
help Help about any command
|
|
ls Print table of content
|
|
version Print the version number of papeer
|
|
|
|
Flags:
|
|
-d, --delay int wait before downloading next chapter, in milliseconds (default -1)
|
|
-f, --format string file format [md, epub, mobi] (default "md")
|
|
-h, --help help for papeer
|
|
-i, --include include URL as first chapter, in resursive mode
|
|
-o, --output string output file
|
|
-q, --quiet do not show progress bars
|
|
-r, --recursive create one chapter per natigation item
|
|
-s, --selector string table of content CSS selector
|
|
--stdout print to standard output
|
|
|
|
Use "papeer [command] --help" for more information about a command.
|
|
```
|
|
|
|
# Autocompletion
|
|
|
|
Execute this command in your current shell, or add it to your `.bashrc`.
|
|
|
|
```sh
|
|
. <(papeer completion bash)
|
|
```
|
|
|
|
Type `papeer completion bash -h` for more information.
|
|
|
|
You can replace `bash` by your own shell (zsh, fish or powershell).
|
|
|
|
# Dependencies
|
|
|
|
- `cobra` command line interface
|
|
- `go-readability` extract content from HTML
|
|
- `html-to-markdown` convert HTML to Markdown
|
|
- `go-epub` convert HTML to EPUB
|
|
- `colly` query HTML trees
|
|
- `uiprogress` display progress bars
|