📝
Executable Documentation
Turn your README setup instructions into executable YAML configurations
Developer-friendly CLI tool for automating local development environment setup
Download the latest release from GitHub Releases or install with:
go install github.com/SphereStacking/plexr/cmd/plexr@v0.1.0Install Plexr and get started in minutes:
# Install latest release
go install github.com/SphereStacking/plexr/cmd/plexr@latest
# Or download pre-built binary
curl -sSL https://github.com/SphereStacking/plexr/releases/latest/download/plexr_$(uname -s)_$(uname -m | sed 's/x86_64/x86_64/;s/aarch64/arm64/').tar.gz | tar xz
sudo mv plexr /usr/local/bin/
# Run your first plan
plexr execute setup.ymlPlexr makes environment setup:
name: "My Project Setup"
version: "1.0.0"
steps:
- id: install_deps
description: "Install dependencies"
executor: shell
files:
- path: "scripts/install.sh"
platform: linux
- path: "scripts/install.ps1"
platform: windows
- id: setup_database
description: "Initialize database"
executor: shell
depends_on: [install_deps]
files:
- path: "scripts/db_setup.sh"