Skip to content

furry tui app for searching/downloading/fetching images from e621/e926

License

Notifications You must be signed in to change notification settings

MertGunduz/yiffy

Repository files navigation

yiffy

yiffy_logo_readme

E621/E926 Search and Download TUI App

Yiffy is a basic Text User Interface (TUI) application developed to provide the process of searching, fetching, and downloading images from e621 and e926.

Table of Contents

Dependencies

Mandatory Dependencies:

Optional Dependencies:

Manual Build Instructions

Follow these steps to compile and install Yiffy manually:

git clone https://github.com/MertGunduz/yiffy.git
cd yiffy
mkdir build && cd build
cmake ..
make
sudo cmake --install .

Guide to Yiffy Commands

Search and TUI (Text User Interface)

Interact with the application through a user-friendly interface

  • yiffy search tui argument:
    • --search "tag1+tag2": Enhance your search experience with an intuitive TUI.

API Fetch and Download

Quickly fetch and download images based on tags

  • yiffy api fetch arguments:
    • --fetch "tag1+tag2": Retrieve URLs based on specified tags.
    • --dfetch "tag1+tag2": Fetch URLs and download the images instantly.

Information and Help

Get help and information about Yiffy

  • yiffy information menu arguments:
    • --help: Access a guide and list of commands.
    • --version: Check the current version of Yiffy.
    • --github: Visit the Yiffy GitHub repository.
    • --config: Open the configuration menu.

Configuration

Adjust settings and configurations as per your preference

  • yiffy configuration and credential arguments:
    • --nsfw "on/off": Toggle NSFW (Not Safe for Work) and SFW (Safe For Work) content.
    • --ivcommand "cmd": Set the command used to view images in search system.
    • --uname "uname": Set the uname used to send API requests.
    • --apikey "apikey": Set the API key used to send API requests.