Downloading and running

Back to Help

gScreen is packaged as a single static unit, so there's no installation to speak of. Just download and run!

Install with Homebrew (macOS only)

❯ brew tap gscreen/gscreen
❯ brew install gscreen

Install manually

Start by downloading a release for your target platform (Linux or macOS) and processor type. You should now have a tar.gz archive in your Downloads directory. Let's extract gScreen and run it.

Open a terminal window and run:

# Navigate to your Downloads directorycd ~/Downloads

❯ ls
gscreen-macos-arm64.bin.tar.gz

# Decompress and rename to something less unwieldy
❯ tar xzvf gscreen-macos-arm64.bin.tar.gz
x gscreen-macos.arm64.bin
❯ mv gscreen-macos-arm64.bin.tar.gz gscreen

# On macOS only: allow the binary to execute without a warning prompt
❯ xattr -d com.apple.quarantine gscreen

# And run!
❯ ./gscreen
Generate randomized slideshows from your Google Photos media

Usage:
  gscreen [command]

Available Commands:
  help        Help about any command
  login       Set up Google OAuth API keys
  reindex     Update the local media index without starting the slideshw
  start       Start the gScreen slideshow server

Flags:
  -h, --help   help for gscreen

Use "gscreen [command] --help" for more information about a command.

If you see the gScreen help text when you run ./gscreen, you've completed this step successfully!