Skip to content

Latest commit

 

History

History
299 lines (228 loc) · 8.92 KB

README.md

File metadata and controls

299 lines (228 loc) · 8.92 KB
Raw


Logo

A cli tool to browse and watch Movies/Shows/MORE

Report Bug · Request Feature

Showcase

spy-cli-showcase.mp4

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Disclaimer
  5. Contributing
  6. Contact
  7. inspiration

About The Project

SPY-CLI provides a command-line interface (CLI) tool named spy-cli that allows users to stream movies or TV shows directly from the command line. It is compatible with multiple platforms including Android, Windows, Linux, macOS, and iPhone. Mainly focused on Bollywood & Indian Entertainment (Hindi Audio).

Note: It requires a backend API, For API details, spycli-api.

No API No problem, READ about spycli-noserver before using.

(back to top)

Getting Started

Prerequisites

  • MPV - player used for Windows, macOS, Linux and Android
  • VLC - player used for iOS

Installation

Windows

  • Make sure Python pip and git are installed.
  • Run this Command inside your Terminal (Installing fzf): 
    winget install fzf
  • Clone the repository: 
    git clone https://github.com/junioralive/spy-cli.git
  • Navigate to the cloned directory: 
    cd spy-cli
  • Installing setuptools: 
    pip install --upgrade setuptools wheel
  • Install requirements and dependencies: 
    pip install -e .
  • Install py7zr dependencies: 
    pip install py7zr
  • Install mpv player (Only for windows): 
    spy-cli-player
  • First time run: 
    spy-cli.config

Enter your API URL, choose your platform and you're all set. For API details, spycli-api. No API No problem, READ about spycli-noserver before using.

(back to top)

Linux

  • Make sure Python pip and git are installed.
  • Run this Command inside your Terminal (Installing fzf): 
    sudo apt-get install fzf mpv
  • Clone the repository: 
    git clone https://github.com/junioralive/spy-cli.git
  • Navigate to the cloned directory: 
    cd spy-cli
  • Installing setuptools: 
    pip3 install --upgrade setuptools wheel
  • Install requirements and dependencies: 
    pip3 install -e .
  • First time run: 
    spy-cli.config

Enter your API URL, choose your platform and you're all set. For API details, spycli-api. No API No problem, READ about spycli-noserver before using.

(back to top)

MAC

  • Make sure Python pip and git are installed.
  • Open the Terminal application on your Mac (Installing Homebrew: 
    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  • Installing fzf: 
    brew install fzf mpv
  • Clone the repository: 
    git clone https://github.com/junioralive/spy-cli.git
  • Navigate to the cloned directory: 
    cd spy-cli
  • Installing fzf: 
    sudo apt-get install fzf
  • Installing setuptools: 
    pip install --upgrade setuptools wheel
  • Install requirements and dependencies: 
    pip install -e .
  • First time run: 
    spy-cli.config

Enter your API URL, choose your platform and you're all set. For API details, spycli-api. No API No problem, READ about spycli-noserver before using.

(back to top)

Android

  • Make sure MPV and Termux are installed.
  • Run following commands (Note: this may take a while) 
    pkg update && pkg upgrade
pkg install python git fzf
pip install wheel
git clone https://github.com/junioralive/spy-cli.git
cd spy-cli
pip3 install -e .
  • First time run: 
    spy-cli.config

Enter your API URL, choose your platform and you're all set. For API details, spycli-api. No API No problem, READ about spycli-noserver before using.

(back to top)

iOS

  • Make sure VLC MEDIA PLAYER and iSH are installed.

  • Run following commands (Note: this may take a while)

    apk update && apk upgrade
apk add python3 git fzf
python3 -m ensurepip --upgrade
git clone https://github.com/junioralive/spy-cli.git
cd spy-cli
pip3 install -e .

  • First time run:

    spy-cli.config

Enter your API URL, choose your platform and you're all set. For API details, spycli-api. No API No problem, READ about spycli-noserver before using.

(back to top)

Usage

Type: spy-cli into your Commandline.

For no-server version

Type: spy-cli-basic into your Commandline.

READ about spycli-noserver before using.

(back to top)

Disclaimer

This project is designed to be utilized at the discretion and responsibility of the user, taking into consideration the specific legal and governmental regulations applicable to their context. The project does not exercise control over the nature of the content it disseminates. Consequently, any use of copyrighted material sourced from providers falls under the user’s own risk and accountability, and is not the responsibility of the project developers

(back to top)

Feature

If you want a feature, create an issue or create the feature and make a pull request.

(back to top)

Contributing

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

Contact

Author: JuniorAlive Discord: junioralive Discord Server Project Link

(back to top)

Inspiration

Heavily inspired from ani-cli mov-cli

(back to top)