zotify/INSTALLATION.md

1.8 KiB

Installing Zotify

Windows

This guide uses Scoop (https://scoop.sh) to simplify installing prerequisites and pipx to manage Zotify itself. There are other ways to install and run Zotify on Windows but this is the official recommendation, other methods of installation will not receive support.

  • Open PowerShell (cmd will not work)
  • Install Scoop by running:
    • Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
    • irm get.scoop.sh | iex
  • After installing scoop run: scoop install python ffmpeg-shared git
  • Install pipx:
    • python3 -m pip install --user pipx
    • python3 -m pipx ensurepath Now close PowerShell and reopen it to ensure the pipx command is available.
  • Install Zotify with: pipx install https://get.zotify.xyz
  • Done! Use zotify --help for a basic list of commands or check the README.md file in Zotify's code repository for full documentation.

macOS

  • Open the Terminal app
  • Install Homebrew (https://brew.sh) by running: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  • After installing Homebrew run: brew install python@3.11 pipx ffmpeg git
  • Setup pipx: pipx ensurepath
  • Install Zotify: pipx install https://get.zotify.xyz
  • Done! Use zotify --help for a basic list of commands or check the README.md file in Zotify's code repository for full documentation.

Linux (Most Popular Distributions)

  • Install python3, pip (if a separate package), ffmpeg, and git from your distribution's package manager or software center.
  • Then install pipx, either from your package manager or through pip with: python3 -m pip install --user pipx
  • Install Zotify pipx install https://get.zotify.xyz
  • Done! Use zotify --help for a basic list of commands or check the README.md file in Zotify's code repository for full documentation.