aniwrapper/docs/man/aniwrapper.1.md
Kyle Yasuda fd954e7ede
Add episode selection param (#18)
* fix quality selection

* add episode selection argument

* fix quality selection menu appearing when flag not set

* fix episode selection appearing when no episodes released yet

* update readme

* update readme

* make selected quality the default if watching/downloading multiple episodes
2022-10-06 20:17:48 -07:00

2.8 KiB

title section header footer date
ANIWRAPPER 1 Man Page aniwrapper 1.0.0 February 4, 2022

NAME

aniwrapper - A rofi wrapper around ani-cli: a command-line tool to stream, download, and play anime

SYNOPSIS

aniwrapper [-adhpqrSv] [-t theme | -T config_path] [query]
aniwrapper -f directory_path [-t theme | -T config_path] [-pSv] [query]
aniwrapper -c [-dhpqrSv] [query]
aniwrapper -Q query
aniwrapper -C

DESCRIPTION

aniwrapper is a wrapper around a modified version of ani-cli, which uses rofi to get user input and control the program flow, as well as a a sqlite3 database for tracking search/watch history

OPTIONS

Defaults:

  • rofi enabled
  • aniwrapper.rasi theme
  • best quality
-a
Enable autoplay in streaming mode
-c
Enable command-line mode (disable rofi)
-C
Connect to the history database $XDG_CONFIG_HOME/aniwrapper/history.sqlite3
-d
Enable downloading anime in command-line mode
-e episode or begin_episode - end_episode
Select episode(s) to stream/download
-f
Specify the starting search directory for "Play from File" mode
-h
Display the help message
-p
Enable video player selection menu
-P
Enable provider selection menu
-q
Enable quality selection
-r
Start script at episode selection for the most recently watched anime
-Q query
Run a query on the history databse
-S
Enable silent mode (suppress all output) [cannot be used with -v]
-t alter|aniwrapper (default)|dracula|doomone|fancy|flamingo|material|monokai|nord|onedark
Choose theme from presets
-T path_to_theme
Provide custom rofi theme
-v
Verbose output

EXAMPLES

aniwrapper
Launch main menu with default options
aniwrapper konosuba
Run in stream mode with a search query = "konosuba"
aniwrapper -qd naruto
Run in download mode with quality selection enabled and a search query = "naruto"
aniwrapper -vqt doomone
Run with quality selection enabled and the doomone theme
aniwrapper -cqd
Run in command-line download mode with quality selection enabled (rofi disabled)
aniwrapper -Q "SELECT * FROM watch_history ORDER BY watch_date DESC LIMIT 10;"
Query history database for your 10 most recently watched anime
aniwrapper -f /media/videos -t dracula
Run in Play from File mode, using the dracula theme, and with the search starting from /media/videos
aniwrapper -S
Run in silent mode (suppress all output to stdout and disable notifications)

SEE ALSO

rofi(1), rofi-theme(5), rofi-keys(5), sqlite3(1)

AUTHOR

Written by Kyle Yasuda ksyasuda@umich.edu

Original code based on pystardust's ani-cli (https://github.com/pystardust/ani-cli)