From 04aa42a9c9d8c0a84f5fac79af8f6a7e8ececa3f Mon Sep 17 00:00:00 2001 From: Karol Broda Date: Sat, 20 Dec 2025 20:20:44 +0100 Subject: [PATCH] feat: add install script for automated binary installation --- README.md | 13 +++++++ install.sh | 110 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 123 insertions(+) create mode 100755 install.sh diff --git a/README.md b/README.md index f622670..6852441 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,18 @@ yay -S snitch-bin paru -S snitch-bin ``` +### shell script + +```bash +curl -sSL https://raw.githubusercontent.com/karol-broda/snitch/master/install.sh | sh +``` + +installs to `~/.local/bin` if available, otherwise `/usr/local/bin`. override with: + +```bash +curl -sSL https://raw.githubusercontent.com/karol-broda/snitch/master/install.sh | INSTALL_DIR=~/bin sh +``` + ### binary download from [releases](https://github.com/karol-broda/snitch/releases): @@ -51,6 +63,7 @@ sudo mv snitch /usr/local/bin/ ``` > **macos:** if blocked with "cannot be opened because the developer cannot be verified", run: +> > ```bash > xattr -d com.apple.quarantine /usr/local/bin/snitch > ``` diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..4e860f6 --- /dev/null +++ b/install.sh @@ -0,0 +1,110 @@ +#!/bin/sh +set -e + +REPO="karol-broda/snitch" +BINARY_NAME="snitch" + +# allow override via environment +INSTALL_DIR="${INSTALL_DIR:-}" + +detect_install_dir() { + if [ -n "$INSTALL_DIR" ]; then + echo "$INSTALL_DIR" + return + fi + + # prefer user-local directory if it exists and is in PATH + if [ -d "$HOME/.local/bin" ] && echo "$PATH" | grep -q "$HOME/.local/bin"; then + echo "$HOME/.local/bin" + return + fi + + # fallback to /usr/local/bin + echo "/usr/local/bin" +} + +detect_os() { + os=$(uname -s | tr '[:upper:]' '[:lower:]') + case "$os" in + darwin) echo "darwin" ;; + linux) echo "linux" ;; + *) + echo "error: unsupported operating system: $os" >&2 + exit 1 + ;; + esac +} + +detect_arch() { + arch=$(uname -m) + case "$arch" in + x86_64|amd64) echo "amd64" ;; + aarch64|arm64) echo "arm64" ;; + armv7l) echo "armv7" ;; + *) + echo "error: unsupported architecture: $arch" >&2 + exit 1 + ;; + esac +} + +fetch_latest_version() { + version=$(curl -sL "https://api.github.com/repos/${REPO}/releases/latest" | grep '"tag_name"' | head -1 | cut -d'"' -f4) + if [ -z "$version" ]; then + echo "error: failed to fetch latest version" >&2 + exit 1 + fi + echo "$version" +} + +main() { + os=$(detect_os) + arch=$(detect_arch) + install_dir=$(detect_install_dir) + version=$(fetch_latest_version) + version_no_v="${version#v}" + + archive_name="${BINARY_NAME}_${version_no_v}_${os}_${arch}.tar.gz" + download_url="https://github.com/${REPO}/releases/download/${version}/${archive_name}" + + echo "installing ${BINARY_NAME} ${version} for ${os}/${arch}..." + + tmp_dir=$(mktemp -d) + trap 'rm -rf "$tmp_dir"' EXIT + + echo "downloading ${download_url}..." + if ! curl -sL --fail "$download_url" -o "${tmp_dir}/${archive_name}"; then + echo "error: failed to download ${download_url}" >&2 + exit 1 + fi + + echo "extracting..." + tar -xzf "${tmp_dir}/${archive_name}" -C "$tmp_dir" + + if [ ! -f "${tmp_dir}/${BINARY_NAME}" ]; then + echo "error: binary not found in archive" >&2 + exit 1 + fi + + # remove macos quarantine attribute + if [ "$os" = "darwin" ]; then + xattr -d com.apple.quarantine "${tmp_dir}/${BINARY_NAME}" 2>/dev/null || true + fi + + # install binary + if [ -w "$install_dir" ]; then + mv "${tmp_dir}/${BINARY_NAME}" "${install_dir}/${BINARY_NAME}" + else + echo "elevated permissions required to install to ${install_dir}" + sudo mv "${tmp_dir}/${BINARY_NAME}" "${install_dir}/${BINARY_NAME}" + fi + + chmod +x "${install_dir}/${BINARY_NAME}" + + echo "installed ${BINARY_NAME} to ${install_dir}/${BINARY_NAME}" + echo "" + echo "run '${BINARY_NAME} --help' to get started" +} + +main +