FLIX-CLI

A high efficient, powerful and fast movie scraper.

---

---

Overview

• Installation
  1. PIP Installation
  2. AUR (Arch Linux)
  3. Homebrew (MacOS)
  4. Scoop (Windows)
  5. WSL (Alternative Window Installation)
  6. Source Code Download
  7. Android Installation
• Dependencies
• Usage
• Configuration
• Support
• Provider
• Project Disclaimer
• Star History
• Contributing
• Honourable Mentions

Installation

for dependencies (see below).

This project can be installed on to your device via different mechanisms, these mechanisms are listed below in the order of ease.

1. PIP Installs Packages aka PIP Installation

pip install flix-cli

2. AUR (Arch Linux)

paru -S flix-cli

3. Homebrew (MacOS)

Homebrew support comming soon

4. Scoop (Windows)

Make sure scoop package manager is installed in your system.

scoop bucket add extras
scoop bucket add flix-cli https://github.com/DemonKingSwarn/flix-cli-bucket.git
scoop install flix-cli

5. WSL (Alternative Windows Installation)

Note that the media player (mpv) will need to be installed on Windows, not WSL.

When installing the media player on Windows, make sure that it is on the Windows Path. An easy way to ensure this is to download the media player with a package manager (on Windows, not WSL) such as scoop.

6. Installing from source

First ensure UV is installed (blazingly fast Python package manager written in Rust).

Then run the following command:

git clone https://codeberg.org/s-warn/flix-cli.git \
&& cd flix-cli \
&& uv sync \
&& uv pip install -e . \
&& cd ..

Alternative with Poetry (legacy):

git clone https://codeberg.org/s-warn/flix-cli.git \
&& cd flix-cli \
&& poetry build \
&& pip install -e . \
&& cd ..

Additional information: You must have Python installed and in PATH to use this project properly. Your Python executable may be py or python or python3. Only Python 3.11 and higher versions are supported by the project.

7. Android Installation

Install termux (Guide)

pkg up -y
pkg install python fzf
pip install flix-cli

Dependencies

• mpv - Video Player
• iina - Alternate video player for MacOS
• vlc - Video Player for Android
• ffmpeg - Download manager
• fzf - for selection menu

Usage

Usage: flix-cli [OPTIONS] [QUERY]...

QUERY is the title you want to search for (e.g., breaking bad, dune, oppenheimer).

Options

Option	Alias	Description
--action <play|download|cast>	-a	Choose whether to play, download, or cast the selected media. Defaults to play.
--season <number>	-s	(Series only) Specify a season number.
--episodes <range>	-e	(Series only) Specify a single episode (5) or a range (3-7).
--help		Show help message and exit.

🎬 Examples

Search & Play a Movie

flix-cli dune

Download a Movie

flix-cli dune --action download

Play a TV Episode

flix-cli "breaking bad" --season 1 --episodes 1

Play a Range of Episodes

flix-cli "the office" -s 3 -e 5-10

Chromecast Playback

flix-cli avatar -a cast

Configuration

• Windows: %APPDATA%/flix-cli/flix-cli.conf
• Linux/MacOS/FreeBSD: $HOME/.config/flix-cli/flix-cli.conf

example config file:

dl_dir="/home/swarn/dl"

Support

You can contact the developer directly via this email. However, the most recommended way is to head to the discord server.

If you run into issues or want to request a new feature, you are encouraged to make a GitHub issue, won't bite you, trust me.

Provider

Website	Available Qualities	Status / Elapsed Time	Content Extension
flixhq	720p, 1080p		MP4

Project Disclaimer

The disclaimer of the project can be found here.

Star History

Contributing

Pull requests are welcome and appreciated. For major changes, please open an issue first to discuss what you would like to change.

Honourable Mentions

• animdl: Ridiculously efficient, fast and light-weight (supports most sources: animixplay, 9anime...) (Python)
• ani-cli: A cli tool to browse and play anime. (Shell)
• mov-cli: [WIP] watch movies and webseries from the cli. (Python/Shell)
• kami: Read light novels and watch anime in your terminal. (Rust)