Installation

Install Shiro on macOS, Linux, or Windows. Docker is the recommended method — no dependencies required.

Option 1: Docker

Recommended

Pull the pre-built image from GitHub Container Registry. No Go toolchain or platform binary needed.

bash

# Pull the latest image
docker pull ghcr.io/rajitk13/shiro-automation:latest

# Verify
docker run --rm ghcr.io/rajitk13/shiro-automation:latest shiro version

Run workflows by mounting your project directory:

bash

docker run --rm \
  -v $(pwd):/workspace \
  -w /workspace \
  ghcr.io/rajitk13/shiro-automation:latest \
  shiro run

Pin to a specific build tag for reproducible CI:

bash

docker pull ghcr.io/rajitk13/shiro-automation:v20260525-103919-ba52c2c

Image Variants

Two image variants are available:

slim(default)

Alpine base with shiro binary, git, and curl. Use for built-in modules and pre-built binary subprocess modules. Small image size.

bash

docker pull ghcr.io/rajitk13/shiro-automation:latest

toolchain(latest-go)

Based on golang:1.23-alpine with full Go toolchain. Use only for go-run subprocess modules.

bash

docker pull ghcr.io/rajitk13/shiro-automation:latest-go

Both variants support linux/amd64 and linux/arm64, and embed the release version (use shiro --version to check).

Option 2: Auto-Detect Script

Detects your platform and installs the correct binary automatically.

bash

curl -sSL https://raw.githubusercontent.com/rajitk13/shiro-automation/master/scripts/install-auto.sh | bash

Option 3: Pre-built Binaries

Download directly from GitHub releases:

macOS (Apple Silicon)

bash

curl -LO https://github.com/rajitk13/shiro-automation/releases/latest/download/shiro-darwin-arm64
chmod +x shiro-darwin-arm64
sudo mv shiro-darwin-arm64 /usr/local/bin/shiro

macOS (Intel)

bash

curl -LO https://github.com/rajitk13/shiro-automation/releases/latest/download/shiro-darwin-amd64
chmod +x shiro-darwin-amd64
sudo mv shiro-darwin-amd64 /usr/local/bin/shiro

Linux (AMD64)

bash

curl -LO https://github.com/rajitk13/shiro-automation/releases/latest/download/shiro-linux-amd64
chmod +x shiro-linux-amd64
sudo mv shiro-linux-amd64 /usr/local/bin/shiro

Linux (ARM64)

bash

curl -LO https://github.com/rajitk13/shiro-automation/releases/latest/download/shiro-linux-arm64
chmod +x shiro-linux-arm64
sudo mv shiro-linux-arm64 /usr/local/bin/shiro

Windows (AMD64)

bash

curl -LO https://github.com/rajitk13/shiro-automation/releases/latest/download/shiro-windows-amd64.exe
# Move to a directory in your PATH and rename to shiro.exe

Option 4: Build from Source

Requires Go 1.23 or later.

bash

git clone https://github.com/rajitk13/shiro-automation.git
cd shiro-automation
go build -o shiro ./cmd/runtime
sudo mv shiro /usr/local/bin/

Verify Installation

After installation, verify Shiro is working:

bash

shiro version
shiro help

Next Steps

Now that you have Shiro installed, initialize your first project:

bash

shiro init
shiro run