Installation

Plexr can be installed in several ways depending on your platform and preferences.

System Requirements

• Operating System: macOS, Linux, or Windows
• Architecture: amd64 or arm64
• Go: Version 1.21+ (only for building from source)

Installation Methods

Using Go Install (Recommended)

If you have Go installed, this is the simplest method:

# Install the latest version
go install github.com/SphereStacking/plexr/cmd/plexr@latest

# Or install a specific version (e.g., v0.1.0)
go install github.com/SphereStacking/plexr/cmd/plexr@v0.1.0

This will install Plexr to your $GOPATH/bin directory.

Building from Source

For the latest development version or to contribute:

# Clone the repository
git clone https://github.com/SphereStacking/plexr.git
cd plexr

# Install dependencies
make deps

# Build the binary
make build

# Install to your PATH
make install

Package Managers

Homebrew (macOS/Linux)

Coming soon:

brew install plexr

Scoop (Windows)

Coming soon:

scoop install plexr

Binary Releases

Pre-built binaries are available for multiple platforms. Download from the releases page.

Linux (x86_64)

# Download the latest release
curl -sSL https://github.com/SphereStacking/plexr/releases/latest/download/plexr_Linux_x86_64.tar.gz | tar xz
sudo mv plexr /usr/local/bin/

# Or download a specific version (e.g., v0.1.0)
curl -sSL https://github.com/SphereStacking/plexr/releases/download/v0.1.0/plexr_Linux_x86_64.tar.gz | tar xz
sudo mv plexr /usr/local/bin/

Linux (arm64)

# Download the latest release
curl -sSL https://github.com/SphereStacking/plexr/releases/latest/download/plexr_Linux_arm64.tar.gz | tar xz
sudo mv plexr /usr/local/bin/

# Or download a specific version (e.g., v0.1.0)
curl -sSL https://github.com/SphereStacking/plexr/releases/download/v0.1.0/plexr_Linux_arm64.tar.gz | tar xz
sudo mv plexr /usr/local/bin/

macOS (Intel)

# Download the latest release
curl -sSL https://github.com/SphereStacking/plexr/releases/latest/download/plexr_Darwin_x86_64.tar.gz | tar xz
sudo mv plexr /usr/local/bin/

# Or download a specific version (e.g., v0.1.0)
curl -sSL https://github.com/SphereStacking/plexr/releases/download/v0.1.0/plexr_Darwin_x86_64.tar.gz | tar xz
sudo mv plexr /usr/local/bin/

macOS (Apple Silicon)

# Download the latest release
curl -sSL https://github.com/SphereStacking/plexr/releases/latest/download/plexr_Darwin_arm64.tar.gz | tar xz
sudo mv plexr /usr/local/bin/

# Or download a specific version (e.g., v0.1.0)
curl -sSL https://github.com/SphereStacking/plexr/releases/download/v0.1.0/plexr_Darwin_arm64.tar.gz | tar xz
sudo mv plexr /usr/local/bin/

Windows

1. Download the appropriate file from the releases page:
   • For latest: plexr_Windows_x86_64.zip
   • For v0.1.0: Download from the v0.1.0 release page
2. Extract the zip file
3. Add the directory to your PATH or move plexr.exe to a directory in your PATH

Verify installation

plexr version

Verifying Installation

After installation, verify that Plexr is correctly installed:

plexr --version

You should see output like:

plexr version 0.1.0

Shell Completion

Plexr supports shell completion for bash, zsh, fish, and PowerShell.

Bash

# Add to ~/.bashrc
echo 'source <(plexr completion bash)' >> ~/.bashrc
source ~/.bashrc

Zsh

# Add to ~/.zshrc
echo 'source <(plexr completion zsh)' >> ~/.zshrc
source ~/.zshrc

Fish

plexr completion fish | source
# To persist:
plexr completion fish > ~/.config/fish/completions/plexr.fish

PowerShell

# Add to your PowerShell profile
plexr completion powershell | Out-String | Invoke-Expression

Environment Variables

Plexr respects the following environment variables:

• PLEXR_STATE_FILE: Override the default state file location
• PLEXR_LOG_LEVEL: Set logging level (debug, info, warn, error)
• PLEXR_NO_COLOR: Disable colored output

Example:

export PLEXR_LOG_LEVEL=debug
export PLEXR_STATE_FILE=/tmp/plexr_state.json

Upgrading

Using Go

# Upgrade to the latest version
go install github.com/SphereStacking/plexr/cmd/plexr@latest

# Or upgrade to a specific version
go install github.com/SphereStacking/plexr/cmd/plexr@v0.1.0

From Source

cd plexr
git pull
make clean build install

Uninstalling

Installed with Go

rm $(go env GOPATH)/bin/plexr

Manual Installation

rm /usr/local/bin/plexr

Cleanup State Files

Plexr creates state files in your project directories:

# Remove state files
find . -name ".plexr_state.json" -delete

Troubleshooting

Command Not Found

If you get "command not found" after installation:

1. Check if the binary is in your PATH:

   which plexr

2. For Go installations, ensure $GOPATH/bin is in your PATH:

   echo 'export PATH=$PATH:$(go env GOPATH)/bin' >> ~/.bashrc
   source ~/.bashrc

Permission Denied

If you get permission errors:

chmod +x /path/to/plexr

Version Conflicts

If you have multiple versions installed:

# Find all plexr installations
which -a plexr

# Use specific version
/usr/local/bin/plexr --version

Next Steps

• Read the Getting Started Guide
• Learn about Configuration
• See Examples of real-world usage