anifetch-cli 1.0.2__tar.gz → 1.0.4__tar.gz

{anifetch_cli-1.0.2/src/anifetch_cli.egg-info → anifetch_cli-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anifetch-cli
-Version: 1.0.2
+Version: 1.0.4
 Summary: Animated terminal fetch with video and audio support.
 Author-email: Notenlish <notenlish@gmail.com>
 Maintainer: Immelancholy
@@ -33,11 +33,34 @@ This is a small tool built with fastfetch/neofetch, ffmpeg and chafa. It allows
 
 ## Installation
 
-### Installation for Linux
+**Quick Links Installation Guide For:** 
 
-Recommended Python version: 3.11 and later. If you use NixOS refer to [Installation for NixOS](#installation-for-nixos).
+[Linux](#installation-for-linux-system) • [Windows](#installation-for-windows-winget-or-scoop) • [macOS](#installation-for-macos-homebrew)• [Manual](#manual-installation) • [Development](#developer-installation)
 
-Run this in the terminal.
+### Installation for Linux System
+Recommended Python version: 3.11 and later.
+
+#### Installation for Arch / Arch-based distros (Community maintained)
+
+Anifetch is available in the AUR package [anifetch-cli](https://aur.archlinux.org/packages/anifetch-cli), maintained by @AmmarSyamil.
+
+Install it from the terminal. For example, with Yay:
+
+```bash
+yay -S anifetch-cli
+```
+
+After installation, run this to test if anifetch was installed correctly:
+
+```bash
+anifetch example.mp4
+```
+Please read our [User guide](#user-guide) for more info on how to use anifetch.
+
+#### Installation for other Linux Distro.
+If you use NixOS refer to Installation for [NixOS](#installation-for-nixos).
+
+Install it from the terminal. For example, with Yay:
 
 ```bash
 curl https://raw.githubusercontent.com/Notenlish/anifetch/refs/heads/main/install.sh | bash
@@ -49,10 +72,12 @@ After installation, run this to test if anifetch was installed correctly:
 anifetch example.mp4
 ```
 
+
 Please read our [User guide](#user-guide) for more info on how to use anifetch.
 
 ---
 
+
 ### Installation for Windows (Winget or Scoop)
 
 Check whether you have winget installed by running `winget` in the windows terminal. If you dont have it, install it [here](https://github.com/microsoft/winget-cli/?tab=readme-ov-file#installing-the-client). If you want, you can use [Scoop](https://scoop.sh/) instead. Just replace the `winget` part with `scoop`.
@@ -72,7 +97,10 @@ After installing the necessary dependencies using winget/scoop, install anifetch
 > [!WARNING]
 > **Do not** install `anifetch` on pypi, it is not related with this project. Install `anifetch-cli`.
 
-### Installation for MacOS with Homebrew
+Please read our [Post installation](#post-installation) and [User guide](#user-guide) for more info on how to use anifetch.
+
+
+### Installation for macOS (HomeBrew)
 
 Install homebrew if you haven't installed it already by following the guide [here](https://brew.sh/).
 
@@ -199,7 +227,7 @@ After you've done these steps, rebuild your system.
 
 ---
 
-### Developer Installation (for contributors):
+### Developer Installation
 
 ```bash
 git clone https://github.com/Notenlish/anifetch.git
@@ -265,6 +293,7 @@ _Note : by default, the video `example.mp4` can directly be used as an example._
 - `--quality`: Changes the output quality of ffmpeg when extracting frames. This doesn't have much effect on the quality or speed from my testing, so you shouldn't need to change this. 2 highest quality, 10 lowest quality.
 - `--loop`: Determines how many times the animation should loop. Default is -1(always loop).
 - `--no-key-exit`: Don't exit anifetch when user presses a key.
+- `--no-input-restore`: Disable restoring pressed keys back into the terminal after stopping Anifetch. Use this if your OS gives security prompts saying `"Anifetch" is requesting special priviliges` when you press a key to stop Anifetch.
 - `-c` / `--config`: Specify a non-default config for Neofetch/Fastfetch.
   - Accepts a path or preset name (e.g. `main`).
   - Neofetch (Linux/macOS): `~/.config/neofetch/main.conf`
@@ -326,6 +355,8 @@ Make sure to install the dependencies listed on [Prerequisites](#Prerequisites).
 
 If weird characters are appearing in your terminal then your terminals font probably can't render some characters. Consider installling [nerdfonts](https://www.nerdfonts.com/).
 
+If your OS is prompting you about `"Anifetch" is requesting special priviliges` or something similiar after pressing a key to stop the running Anifetch instance, add this argument: `--no-input-restore`. The technical reason for this is that Anifetch records the keys you press and enters them back to the terminal on your behalf. That way you can immediately run whatever command you want, without having to re-enter a key or two. Certain OS's have built-in protections against this as a security notice, which is why you might encounter a security prompt. 
+
 ## Notes
 
 Anifetch attempts to cache the animation so that it doesn't need to render them again when you run it with the same file. However, if the name of the file is the same, but it's contents has changed, it won't re-render it. In that case, you will need to add `--force-render` as an argument to `anifetch.py` so that it re-renders it. You only have to do this only once when you change the file contents.

{anifetch_cli-1.0.2 → anifetch_cli-1.0.4}/README.md

@@ -6,11 +6,34 @@ This is a small tool built with fastfetch/neofetch, ffmpeg and chafa. It allows
 
 ## Installation
 
-### Installation for Linux
+**Quick Links Installation Guide For:** 
 
-Recommended Python version: 3.11 and later. If you use NixOS refer to [Installation for NixOS](#installation-for-nixos).
+[Linux](#installation-for-linux-system) • [Windows](#installation-for-windows-winget-or-scoop) • [macOS](#installation-for-macos-homebrew)• [Manual](#manual-installation) • [Development](#developer-installation)
 
-Run this in the terminal.
+### Installation for Linux System
+Recommended Python version: 3.11 and later.
+
+#### Installation for Arch / Arch-based distros (Community maintained)
+
+Anifetch is available in the AUR package [anifetch-cli](https://aur.archlinux.org/packages/anifetch-cli), maintained by @AmmarSyamil.
+
+Install it from the terminal. For example, with Yay:
+
+```bash
+yay -S anifetch-cli
+```
+
+After installation, run this to test if anifetch was installed correctly:
+
+```bash
+anifetch example.mp4
+```
+Please read our [User guide](#user-guide) for more info on how to use anifetch.
+
+#### Installation for other Linux Distro.
+If you use NixOS refer to Installation for [NixOS](#installation-for-nixos).
+
+Install it from the terminal. For example, with Yay:
 
 ```bash
 curl https://raw.githubusercontent.com/Notenlish/anifetch/refs/heads/main/install.sh | bash
@@ -22,10 +45,12 @@ After installation, run this to test if anifetch was installed correctly:
 anifetch example.mp4
 ```
 
+
 Please read our [User guide](#user-guide) for more info on how to use anifetch.
 
 ---
 
+
 ### Installation for Windows (Winget or Scoop)
 
 Check whether you have winget installed by running `winget` in the windows terminal. If you dont have it, install it [here](https://github.com/microsoft/winget-cli/?tab=readme-ov-file#installing-the-client). If you want, you can use [Scoop](https://scoop.sh/) instead. Just replace the `winget` part with `scoop`.
@@ -45,7 +70,10 @@ After installing the necessary dependencies using winget/scoop, install anifetch
 > [!WARNING]
 > **Do not** install `anifetch` on pypi, it is not related with this project. Install `anifetch-cli`.
 
-### Installation for MacOS with Homebrew
+Please read our [Post installation](#post-installation) and [User guide](#user-guide) for more info on how to use anifetch.
+
+
+### Installation for macOS (HomeBrew)
 
 Install homebrew if you haven't installed it already by following the guide [here](https://brew.sh/).
 
@@ -172,7 +200,7 @@ After you've done these steps, rebuild your system.
 
 ---
 
-### Developer Installation (for contributors):
+### Developer Installation
 
 ```bash
 git clone https://github.com/Notenlish/anifetch.git
@@ -238,6 +266,7 @@ _Note : by default, the video `example.mp4` can directly be used as an example._
 - `--quality`: Changes the output quality of ffmpeg when extracting frames. This doesn't have much effect on the quality or speed from my testing, so you shouldn't need to change this. 2 highest quality, 10 lowest quality.
 - `--loop`: Determines how many times the animation should loop. Default is -1(always loop).
 - `--no-key-exit`: Don't exit anifetch when user presses a key.
+- `--no-input-restore`: Disable restoring pressed keys back into the terminal after stopping Anifetch. Use this if your OS gives security prompts saying `"Anifetch" is requesting special priviliges` when you press a key to stop Anifetch.
 - `-c` / `--config`: Specify a non-default config for Neofetch/Fastfetch.
   - Accepts a path or preset name (e.g. `main`).
   - Neofetch (Linux/macOS): `~/.config/neofetch/main.conf`
@@ -299,6 +328,8 @@ Make sure to install the dependencies listed on [Prerequisites](#Prerequisites).
 
 If weird characters are appearing in your terminal then your terminals font probably can't render some characters. Consider installling [nerdfonts](https://www.nerdfonts.com/).
 
+If your OS is prompting you about `"Anifetch" is requesting special priviliges` or something similiar after pressing a key to stop the running Anifetch instance, add this argument: `--no-input-restore`. The technical reason for this is that Anifetch records the keys you press and enters them back to the terminal on your behalf. That way you can immediately run whatever command you want, without having to re-enter a key or two. Certain OS's have built-in protections against this as a security notice, which is why you might encounter a security prompt. 
+
 ## Notes
 
 Anifetch attempts to cache the animation so that it doesn't need to render them again when you run it with the same file. However, if the name of the file is the same, but it's contents has changed, it won't re-render it. In that case, you will need to add `--force-render` as an argument to `anifetch.py` so that it re-renders it. You only have to do this only once when you change the file contents.
@@ -331,4 +362,4 @@ I dont remember where I got the example.mp4 video from, if you know the source o
 
 ## Star History
 
-[![Star History Chart](https://api.star-history.com/svg?repos=Notenlish/anifetch&type=Date)](https://www.star-history.com/#Notenlish/anifetch&Date)
+[![Star History Chart](https://api.star-history.com/svg?repos=Notenlish/anifetch&type=Date)](https://www.star-history.com/#Notenlish/anifetch&Date)

{anifetch_cli-1.0.2 → anifetch_cli-1.0.4}/pyproject.toml

@@ -24,7 +24,7 @@ keywords = [
     "fastfetch",
     "anifetch",
 ]
-version = "1.0.2"
+version = "1.0.4"
 description = "Animated terminal fetch with video and audio support."
 # If I put everyone here it messes with the "author" meta section.
 authors = [{ name = "Notenlish", email = "notenlish@gmail.com" }]

{anifetch_cli-1.0.2 → anifetch_cli-1.0.4}/src/anifetch/cli.py

@@ -111,6 +111,16 @@ parser.add_argument(
     action="store_false",
 )
 
+parser.add_argument(
+    "--no-input-restore",
+    help=(
+        "Disable restoring pressed keys back into the terminal after stopping Anifetch. "
+        "By default Anifetch re-enters your key presses automatically. "
+        "On some systems (eg: Wayland/KDE) Anifetch may trigger a security prompt which can be annoying, add this argument to fix it."
+    ),
+    action="store_false",
+)
+
 parser.add_argument(
     "--quality",
     "-q",

{anifetch_cli-1.0.2 → anifetch_cli-1.0.4}/src/anifetch/core.py

@@ -16,7 +16,7 @@ from .utils import (
     get_ext_from_codec,
     get_data_path,
     default_asset_presence_check,
-    get_video_dimensions,
+    get_media_dimensions,
     get_neofetch_status,
     print_verbose,
     normal_print,
@@ -32,6 +32,11 @@ from .utils import (
     get_fetch_output,
     make_template_from_fetch_lines,
     clear_screen_soft,
+    check_is_video,
+    check_is_image,
+    check_video_transparency,
+    check_image_transparency,
+    split_to_frames,
 )
 from typing import Literal
 from concurrent.futures import ThreadPoolExecutor, Future
@@ -126,9 +131,6 @@ def run_anifetch(args):
         sys.exit(0)
 
     filename = pathlib.Path(args.filename)
-    IS_GIF = False
-    if args.filename:
-        IS_GIF = True
 
     # If the filename is relative, check if it exists in the assets directory.
     if not filename.exists():
@@ -143,6 +145,31 @@ def run_anifetch(args):
             )
             sys.exit(1)
 
+    if not filename.is_file():
+        print("[ERROR] Filename is not a file. Please give an file.")
+        sys.exit(1)
+
+    IS_IMAGE = False
+    IS_GIF = False
+    IS_VIDEO = False
+    IS_TRANSPARENT = False
+    if filename.suffix == ".gif":
+        IS_GIF = True
+        IS_TRANSPARENT = True
+    else:
+        IS_VIDEO = check_is_video(filename)
+        if IS_VIDEO:
+            IS_TRANSPARENT = check_video_transparency(filename)
+    if not IS_GIF and not IS_VIDEO:
+        IS_IMAGE = check_is_image(filename)
+        IS_TRANSPARENT = check_image_transparency(filename)
+
+    if (not IS_GIF) and (not IS_IMAGE) and (not IS_VIDEO):
+        print("[ERROR] File is neither a gif, image or video.")
+        sys.exit(1)
+
+    # TODO: make sure image mode also works as well. currently it raises a runtime Error
+
     newpath = ASSET_PATH / filename.name
 
     try:
@@ -220,7 +247,7 @@ def run_anifetch(args):
     # automatically calculate height if not given
     if should_update and ("--height" not in sys.argv and "-H" not in sys.argv):
         try:
-            vid_w, vid_h = get_video_dimensions(ASSET_PATH / args.filename)
+            vid_w, vid_h = get_media_dimensions(ASSET_PATH / args.filename)
         except RuntimeError as e:
             print(f"[ERROR] {e}")
             sys.exit(1)
@@ -258,38 +285,27 @@ def run_anifetch(args):
         stdout = None if args.verbose else subprocess.DEVNULL
         stderr = None if args.verbose else subprocess.PIPE
 
-        try:
-            result_ffmpeg = subprocess.run(
-                [
-                    "ffmpeg",
-                    "-i",
-                    f"{args.filename}",
-                    "-vf",
-                    f"fps={args.framerate},format=rgba",
-                    "-q:v",
-                    str(
-                        min(max(args.quality or 6, 2), 10)
-                    ),  # 2-5 high quality, 6-10 lower
-                    str(CACHE_PATH / "video/%05d.png")
-                    if IS_GIF
-                    else str(CACHE_PATH / "video/%05d.jpg"),
-                ],
-                stdout=stdout,
-                stderr=stderr,
-                text=True,
-            )
-        except FileNotFoundError as e:
-            if e.errno == errno.ENOENT:
-                print(
-                    "The command Ffmpeg was not found. You probably forgot to install it. You can install it by going to here: https://ffmpeg.org/download.html\n If you installed Ffmpeg but it still doesn't work, check your PATH."
+        if IS_IMAGE:
+            shutil.copy(
+                args.filename, VIDEO_DIR / f"{0:05d}.{filename.suffix}"
+            )  # just a file named 00000.{suffix}
+        else:  # video or gif
+            try:
+                result_ffmpeg = split_to_frames(
+                    args, CACHE_PATH, IS_TRANSPARENT, stdout, stderr
                 )
-                raise SystemExit
+            except FileNotFoundError as e:
+                if e.errno == errno.ENOENT:
+                    print(
+                        "The command Ffmpeg was not found. You probably forgot to install it. You can install it by going to here: https://ffmpeg.org/download.html\n If you installed Ffmpeg but it still doesn't work, check your PATH."
+                    )
+                    raise SystemExit
+                else:
+                    raise
             else:
-                raise
-        else:
-            if result_ffmpeg.returncode != 0:
-                print(f"[ERROR] ffmpeg failed: {result_ffmpeg.stderr}")
-                sys.exit(1)
+                if result_ffmpeg.returncode != 0:
+                    print(f"[ERROR] ffmpeg failed: {result_ffmpeg.stderr}")
+                    sys.exit(1)
 
         print_verbose(should_print_verbose, args.sound_flag_given)
 
@@ -478,9 +494,26 @@ def run_anifetch(args):
         else:
             pass
 
-        if renderer.last_key:
+        if renderer.last_key and args.no_input_restore:
             from pynput.keyboard import Controller, Key
 
+            KEY_MAP = {
+                # Windows sequences
+                "àH": Key.up,
+                "àP": Key.down,
+                "àK": Key.left,
+                "àM": Key.right,
+                "\x00H": Key.up,
+                "\x00P": Key.down,
+                # Unix/macOS ANSI sequences
+                "\x1b[A": Key.up,
+                "\x1b[B": Key.down,
+                "\x1b[C": Key.right,
+                "\x1b[D": Key.left,
+                "\x1b[H": Key.home,
+                "\x1b[F": Key.end,
+            }
+
             keyboard = Controller()
 
             # needed because if I only enter one key even though the user pressed a bunch of keys the keys will be entered disorderly(only the a single key is not automatically entered and the other keys are entered)
@@ -491,13 +524,15 @@ def run_anifetch(args):
             keyboard.press(Key.home)
             keyboard.release(Key.home)
 
-            keyboard.press(renderer.last_key)
+            translated_key = KEY_MAP.get(renderer.last_key, renderer.last_key)
+
+            keyboard.press(translated_key)
 
             # end of line
             keyboard.press(Key.end)
             keyboard.release(Key.end)
 
-            keyboard.release(renderer.last_key)
+            keyboard.release(translated_key)
 
     if pathlib.Path(VIDEO_DIR).exists():
         shutil.rmtree(VIDEO_DIR)  # no need to keep the video frames.

{anifetch_cli-1.0.2 → anifetch_cli-1.0.4}/src/anifetch/renderer.py

@@ -366,7 +366,9 @@ class Renderer:
         # index += 1
 
         if self.no_key_exit:
-            k = self.key_reader.poll()
+            k = (
+                self.key_reader.poll()
+            )  # instead of this maybe use pynput.keyboard.listener instead.
             if k is not None:
                 # if k in ("q", "Q"):
                 self.last_key = k

{anifetch_cli-1.0.2 → anifetch_cli-1.0.4}/src/anifetch/utils.py

@@ -386,10 +386,10 @@ def get_fetch_output(
                             file=sys.stderr,
                         )
                         sys.exit(1)
-                output += ["--config", config_file]
-                # print(output)
-
-            fetch_output = subprocess.check_output(output, text=True).splitlines()
+            output += ["--config", config_file]
+            fetch_output = subprocess.check_output(
+                output, text=True, encoding="utf-8", errors="replace"
+            ).splitlines()
 
         elif neofetch_status == "uninstalled":
             print(
@@ -431,7 +431,9 @@ def get_fetch_output(
                         sys.exit(1)
                 output += ["--config", config_file]
 
-            fetch_output = subprocess.check_output(output, text=True).splitlines()
+            fetch_output = subprocess.check_output(
+                output, text=True, encoding="utf-8", errors="replace"
+            ).splitlines()
 
         except FileNotFoundError as e:
             if e.errno == errno.ENOENT:
@@ -492,7 +494,10 @@ def render_frame(path: Path, width: int, height: int, chafa_args: str) -> str:
     return p.stdout
 
 
-def get_video_dimensions(filename):
+def get_media_dimensions(filename):
+    """
+    Works for both gif, video and image.
+    """
     cmd = [
         "ffprobe",
         "-v",
@@ -532,6 +537,7 @@ def clean_cache_args(cache_args: dict) -> dict:
         "center",
         "loop",
         "no_key_exit",
+        "no_input_restore",
         "config",
     )
     cleaned = deepcopy(cache_args)  # need to deepcopy to not modify original dict.
@@ -620,3 +626,88 @@ def threaded_chafa_frame_gen(
     with open((OUTPUT_DIR / f).with_suffix(".txt"), "w", encoding="utf-8") as file:
         file.write(out)
     return i, out
+
+
+def check_is_image(filename: pathlib.Path):
+    IMAGE_EXTENSIONS = (
+        ".apng",
+        ".png",
+        ".webp",
+        ".jpg",
+        ".jpeg",
+        ".tiff",
+        ".tif",
+        ".bmp",
+        ".ico",
+        ".avif",
+        ".jfif",
+        ".svg",
+    )
+    if any([filename.suffix == ext for ext in IMAGE_EXTENSIONS]):
+        return True
+    return False
+
+
+def check_image_transparency(filename: pathlib.Path):
+    IMAGE_EXTENSIONS_WITH_ALPHA = (".png", ".webp", ".tiff", ".bmp", ".ico", ".avif")
+    if any([filename.suffix == ext for ext in IMAGE_EXTENSIONS_WITH_ALPHA]):
+        return True
+    return False
+
+
+def check_is_video(filename: pathlib.Path):
+    VIDEO_EXTENSIONS = (
+        ".mp4",
+        ".mov",
+        ".avi",
+        ".mkv",
+        ".webm",
+        ".flv",
+        ".wmv",
+        ".m4v",
+        ".mpg",
+        ".mpeg",
+    )
+    if any([filename.suffix == ext for ext in VIDEO_EXTENSIONS]):
+        return True
+    return False
+
+
+def check_video_transparency(filename: pathlib.Path):
+    result = subprocess.run(
+        [
+            "ffprobe",
+            "-v",
+            "error",
+            "-select_streams",
+            "v:0",
+            "-show_entries",
+            "stream=pix_fmt",
+            "-of",
+            "csv=p=0",
+            str(filename),
+        ],
+        capture_output=True,
+    )
+    pix_fmt = result.stdout.strip().decode("utf-8")
+    return "a" in pix_fmt
+
+
+def split_to_frames(args, CACHE_PATH, IS_TRANSPARENT, stdout, stderr):
+    return subprocess.run(
+        [
+            "ffmpeg",
+            "-i",
+            f"{args.filename}",
+            "-vf",
+            f"fps={args.framerate},format=rgba",
+            "-q:v",
+            str(min(max(args.quality or 6, 2), 10)),  # 2-5 high quality, 6-10 lower
+            str(CACHE_PATH / "video/%05d.png")
+            if IS_TRANSPARENT
+            else str(CACHE_PATH / "video/%05d.jpg"),
+        ],
+        stdout=stdout,
+        stderr=stderr,
+        text=True,
+    )

{anifetch_cli-1.0.2 → anifetch_cli-1.0.4/src/anifetch_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anifetch-cli
-Version: 1.0.2
+Version: 1.0.4
 Summary: Animated terminal fetch with video and audio support.
 Author-email: Notenlish <notenlish@gmail.com>
 Maintainer: Immelancholy
@@ -33,11 +33,34 @@ This is a small tool built with fastfetch/neofetch, ffmpeg and chafa. It allows
 
 ## Installation
 
-### Installation for Linux
+**Quick Links Installation Guide For:** 
 
-Recommended Python version: 3.11 and later. If you use NixOS refer to [Installation for NixOS](#installation-for-nixos).
+[Linux](#installation-for-linux-system) • [Windows](#installation-for-windows-winget-or-scoop) • [macOS](#installation-for-macos-homebrew)• [Manual](#manual-installation) • [Development](#developer-installation)
 
-Run this in the terminal.
+### Installation for Linux System
+Recommended Python version: 3.11 and later.
+
+#### Installation for Arch / Arch-based distros (Community maintained)
+
+Anifetch is available in the AUR package [anifetch-cli](https://aur.archlinux.org/packages/anifetch-cli), maintained by @AmmarSyamil.
+
+Install it from the terminal. For example, with Yay:
+
+```bash
+yay -S anifetch-cli
+```
+
+After installation, run this to test if anifetch was installed correctly:
+
+```bash
+anifetch example.mp4
+```
+Please read our [User guide](#user-guide) for more info on how to use anifetch.
+
+#### Installation for other Linux Distro.
+If you use NixOS refer to Installation for [NixOS](#installation-for-nixos).
+
+Install it from the terminal. For example, with Yay:
 
 ```bash
 curl https://raw.githubusercontent.com/Notenlish/anifetch/refs/heads/main/install.sh | bash
@@ -49,10 +72,12 @@ After installation, run this to test if anifetch was installed correctly:
 anifetch example.mp4
 ```
 
+
 Please read our [User guide](#user-guide) for more info on how to use anifetch.
 
 ---
 
+
 ### Installation for Windows (Winget or Scoop)
 
 Check whether you have winget installed by running `winget` in the windows terminal. If you dont have it, install it [here](https://github.com/microsoft/winget-cli/?tab=readme-ov-file#installing-the-client). If you want, you can use [Scoop](https://scoop.sh/) instead. Just replace the `winget` part with `scoop`.
@@ -72,7 +97,10 @@ After installing the necessary dependencies using winget/scoop, install anifetch
 > [!WARNING]
 > **Do not** install `anifetch` on pypi, it is not related with this project. Install `anifetch-cli`.
 
-### Installation for MacOS with Homebrew
+Please read our [Post installation](#post-installation) and [User guide](#user-guide) for more info on how to use anifetch.
+
+
+### Installation for macOS (HomeBrew)
 
 Install homebrew if you haven't installed it already by following the guide [here](https://brew.sh/).
 
@@ -199,7 +227,7 @@ After you've done these steps, rebuild your system.
 
 ---
 
-### Developer Installation (for contributors):
+### Developer Installation
 
 ```bash
 git clone https://github.com/Notenlish/anifetch.git
@@ -265,6 +293,7 @@ _Note : by default, the video `example.mp4` can directly be used as an example._
 - `--quality`: Changes the output quality of ffmpeg when extracting frames. This doesn't have much effect on the quality or speed from my testing, so you shouldn't need to change this. 2 highest quality, 10 lowest quality.
 - `--loop`: Determines how many times the animation should loop. Default is -1(always loop).
 - `--no-key-exit`: Don't exit anifetch when user presses a key.
+- `--no-input-restore`: Disable restoring pressed keys back into the terminal after stopping Anifetch. Use this if your OS gives security prompts saying `"Anifetch" is requesting special priviliges` when you press a key to stop Anifetch.
 - `-c` / `--config`: Specify a non-default config for Neofetch/Fastfetch.
   - Accepts a path or preset name (e.g. `main`).
   - Neofetch (Linux/macOS): `~/.config/neofetch/main.conf`
@@ -326,6 +355,8 @@ Make sure to install the dependencies listed on [Prerequisites](#Prerequisites).
 
 If weird characters are appearing in your terminal then your terminals font probably can't render some characters. Consider installling [nerdfonts](https://www.nerdfonts.com/).
 
+If your OS is prompting you about `"Anifetch" is requesting special priviliges` or something similiar after pressing a key to stop the running Anifetch instance, add this argument: `--no-input-restore`. The technical reason for this is that Anifetch records the keys you press and enters them back to the terminal on your behalf. That way you can immediately run whatever command you want, without having to re-enter a key or two. Certain OS's have built-in protections against this as a security notice, which is why you might encounter a security prompt. 
+
 ## Notes
 
 Anifetch attempts to cache the animation so that it doesn't need to render them again when you run it with the same file. However, if the name of the file is the same, but it's contents has changed, it won't re-render it. In that case, you will need to add `--force-render` as an argument to `anifetch.py` so that it re-renders it. You only have to do this only once when you change the file contents.