Skip to content

Prarambha369/mrstream-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

13 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation



MrStream-Cli is a terminal-based sports event browser and stream launcher built with POSIX shell scripts. It provides a fast, ethical way to find and watch live sports streams directly from your terminal.

A minimalist, terminal-native sports event browser and stream launcher. πŸ“‘

⚠️ IMPORTANT: MrStream-Cli is NOT affiliated with sportsonline.vc, sportssonline.click, or any content provider. Use at your own risk.

Showcase

Table of Contents

Features

  • POSIX-compliant: Lightweight shell scripts with minimal dependencies.
  • Fast Search: Instant search through sports schedules using fzf.
  • Integrated Playback: Seamlessly hands over streams to mpv.
  • Cached Results: Local caching to reduce network load and improve speed.
  • Ethical Design: Requires explicit user consent for third-party sources.

Prerequisites

Ensure you have the following installed:

Dependency Purpose
curl For fetching data
fzf For the interactive search menu
mpv For stream playback
grep, sed Standard Unix utilities
Install Dependencies

Debian/Ubuntu

sudo apt install curl fzf mpv grep sed

Fedora

sudo dnf install curl fzf mpv grep sed

Arch Linux

sudo pacman -S curl fzf mpv grep sed

macOS (Homebrew)

brew install curl fzf mpv grep sed

Android (Termux)

pkg install curl fzf mpv grep sed

Installation

Packaging status

Tier 1 Support: Linux, Mac, Android

These platforms have rock-solid support and are actively tested by maintainers.

Linux

Native Packages

Native packages offer robust update cycles. If available for your distro, we recommend using them.

Debian/Ubuntu
# Add repository (when available)
# sudo add-apt-repository ppa:prarambha369/mrstream-cli
# sudo apt update
# sudo apt install mrstream-cli

# Or install via automatic script:
curl -fsSL https://raw.githubusercontent.com/Prarambha369/mrstream-cli/main/scripts/install.sh | bash
Fedora
# COPR repo (when available)
# sudo dnf copr enable prarambha369/mrstream-cli
# sudo dnf install mrstream-cli

# Or install manually:
curl -fsSL https://raw.githubusercontent.com/Prarambha369/mrstream-cli/main/scripts/install.sh | bash
Arch Linux
# AUR package (when available)
# yay -S mrstream-cli

# Or install from source:
git clone https://github.com/Prarambha369/mrstream-cli.git
cd mrstream-cli
ln -s "$(pwd)/mrstream" ~/.local/bin/mrstream
OpenSUSE
# Install dependencies first:
sudo zypper install curl fzf mpv grep sed

# Then install via script:
curl -fsSL https://raw.githubusercontent.com/Prarambha369/mrstream-cli/main/scripts/install.sh | bash
macOS

Install dependencies via Homebrew:

brew install curl fzf mpv grep sed

Then install MrStream-Cli:

# Automatic (recommended)
curl -fsSL https://raw.githubusercontent.com/Prarambha369/mrstream-cli/main/scripts/install.sh | bash

# Or manual:
git clone https://github.com/Prarambha369/mrstream-cli.git
cd mrstream-cli
ln -s "$(pwd)/mrstream" "$(brew --prefix)/bin/mrstream"

πŸ’‘ Note: On Apple Silicon, ensure mpv is installed via Homebrew for optimal M1/M2/M3 support.

Android (Termux)
  1. Install Termux from F-Droid (recommended) or Play Store.

  2. Update packages and install dependencies:

pkg update -y
pkg install curl fzf mpv grep sed
  1. Install MrStream-Cli:
# Automatic
curl -fsSL https://raw.githubusercontent.com/Prarambha369/mrstream-cli/main/scripts/install.sh | bash

# Or manual
git clone https://github.com/Prarambha369/mrstream-cli.git
cd mrstream-cli
ln -s "$(pwd)/mrstream" "$PREFIX/bin/mrstream"

⚠️ Android 14+: If you encounter permission issues, run:

pkg install termux-am

Tier 2 Support: Windows, WSL, iOS, Steam Deck

Installation is possible but may require additional configuration. Reach out via Issues if you need assistance.

Windows (Git Bash)

MrStream-Cli works best in a POSIX-compatible shell. We recommend Git Bash with Windows Terminal.

Setup Steps:

  1. Install Git for Windows (includes Git Bash).

  2. Install Windows Terminal (preinstalled on Windows 11).

  3. Configure Windows Terminal to use Git Bash:

    • Open Settings β†’ Profiles β†’ Add new profile
    • Name: Git Bash
    • Command line: %GIT_INSTALL_ROOT%\bin\bash.exe -i -l
    • Icon: %GIT_INSTALL_ROOT%\mingw64\share\git\git-for-windows.ico
    • Starting directory: %USERPROFILE%
  4. In Git Bash, install dependencies via Scoop:

# Install Scoop first if needed:
iwr -useb get.scoop.sh | iex

# Then install dependencies:
scoop install curl fzf mpv grep sed
  1. Install MrStream-Cli:
curl -fsSL https://raw.githubusercontent.com/Prarambha369/mrstream-cli/main/scripts/install.sh | bash

Known Issues:

  • ❌ fzf may not render correctly in mintty (default Git Bash terminal). Solution: Use Windows Terminal + Git Bash profile as configured above.
  • ❌ Paths with spaces may cause issues. Solution: Use short paths or quote arguments.
  • ❌ mpv configuration reads from C:\Users\USERNAME\scoop\apps\mpv\current\portable_config.
WSL (Windows Subsystem for Linux)
  1. Install your preferred Linux distribution via WSL (Guide).

  2. Follow the Linux installation instructions above for your distro.

  3. Important: Install mpv on Windows, not WSL, for proper display server access:

# In PowerShell (Windows):
scoop install mpv
# Or download from: https://mpv.io/installation/
  1. Ensure mpv.exe is in your Windows PATH so WSL can invoke it.

ℹ️ Why?: WSL1 lacks GUI support; WSL2 requires WSLg. Using Windows-native mpv ensures consistent playback.

iOS (iSH)
  1. Install iSH from the App Store.

  2. Update APK and install dependencies:

apk update && apk upgrade
apk add curl fzf mpv grep sed git
  1. Install MrStream-Cli:
git clone --depth 1 https://github.com/Prarambha369/mrstream-cli.git ~/.mrstream-cli
cp ~/.mrstream-cli/mrstream /usr/local/bin/mrstream
chmod +x /usr/local/bin/mrstream
rm -rf ~/.mrstream-cli

⚠️ Note: Network operations may be slow on iSH due to emulation overhead. This is an iSH limitation, not MrStream-Cli.

Steam Deck

Quick Install Script:

  1. Switch to Desktop Mode (STEAM β†’ Power β†’ Switch to Desktop).

  2. Open Konsole and run:

# Create bin directory and update PATH
[ ! -d ~/.local/bin ] && mkdir -p ~/.local/bin
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# Install dependencies
sudo pacman -S --noconfirm curl fzf mpv grep sed git

# Install MrStream-Cli
git clone --depth 1 https://github.com/Prarambha369/mrstream-cli.git ~/.mrstream-cli
cp ~/.mrstream-cli/mrstream ~/.local/bin/mrstream
chmod +x ~/.local/bin/mrstream
rm -rf ~/.mrstream-cli

Optional: Desktop Entry for Gaming Mode

echo '[Desktop Entry]
Encoding=UTF-8
Type=Application
Exec=konsole -e mrstream search
Name=MrStream-Cli
Icon=utilities-terminal
Categories=Network;' > ~/.local/share/applications/mrstream-cli.desktop

Then in Steam: Add Game β†’ Add a non-Steam game β†’ Select MrStream-Cli.


Installing from Source (Universal)

Works on any Unix-like system. Baseline for porting efforts.

# 1. Install dependencies (see platform sections above)

# 2. Clone and install:
git clone https://github.com/Prarambha369/mrstream-cli.git
cd mrstream-cli
chmod +x mrstream

# 3. Link to PATH (choose one):
# System-wide (requires sudo):
sudo cp mrstream /usr/local/bin/

# User-only (recommended):
ln -s "$(pwd)/mrstream" ~/.local/bin/mrstream

Uninstall

Remove MrStream-Cli

Linux/macOS (manual install)

rm -f ~/.local/bin/mrstream
# Or if installed system-wide:
sudo rm -f /usr/local/bin/mrstream

Windows (Git Bash + Scoop)

scoop uninstall mrstream-cli  # if installed via scoop
# Or manual:
rm -f ~/.local/bin/mrstream

Android (Termux)

rm -f "$PREFIX/bin/mrstream"

iOS (iSH)

rm -f /usr/local/bin/mrstream

Clean config/cache (optional)

rm -rf ~/.config/mrstream
rm -rf ~/.cache/mrstream

Usage

Basic Search

Run mrstream search to see all available events:

mrstream search

Or search for a specific team or sport:

mrstream search "Liverpool"

Advanced Options

Flag Description
--refresh Force a refresh of the local cache
--player Force a specific player (mpv, vlc, mplayer, cvlc)
--help Display the help menu

You can also set the default player with:

MRSTREAM_PLAYER=vlc mrstream search "Liverpool"

Troubleshooting

Run the doctor command to check if all dependencies are correctly installed:

mrstream doctor
Common Issues
  • fzf not found: Ensure fzf is installed and in your $PATH.
  • Stream won't play: Direct playback may be blocked by the stream provider. Try mpv, vlc, or mplayer, or open the printed referrer URL in a browser.
  • Cache issues: Use mrstream search --refresh to force a cache rebuild.

Configuration

The configuration is stored at ~/.config/mrstream/sources.yaml. By default, external sources are disabled for ethical reasons. You will be prompted to enable a source the first time you search, or you can manually edit the file:

sources:
  sportsonline:
    enabled: true
    acknowledge_non_affiliation: true
Configuration Options
Option Default Description
sources.sportsonline.enabled false Enable/disable the sportsonline source
sources.sportsonline.acknowledge_non_affiliation false Confirm you understand MrStream-Cli is not affiliated with content providers

License

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.


Built with ❀️ by Prarambha369

About

Terminal-based CLI for live sports streaming. Ethical, opt-in, and modular. Integrates mpv & fzf for seamless playback..

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

 
 
 

Contributors