[ Add, Edit ] add installation scripts, summary update

anasfik · anasfik · commit d8907bd44d13 · 2026-01-08T20:39:39.000+01:00
diff --git a/README.md b/README.md
@@ -16,91 +16,108 @@ FlutterGuard CLI analyzes Flutter app APK files and extracts:
 
 ## Installation
 
-### Option 1: Download Pre-Built Binary (Recommended)
+### Quick Install (Recommended)
 
-The easiest way to get started is to download a pre-built binary from the releases page.
+**One-line install for Linux/macOS:**
 
-**Step 1:** Go to the [Releases page](https://github.com/flutterguard/flutterguard-cli/releases) and download the binary for your system:
+```bash
+curl -sSL https://raw.githubusercontent.com/flutterguard/flutterguard-cli/main/install.sh | bash
+```
 
-- **Linux (x64)**: `flutterguard-cli-linux-amd64`
-- **Linux (ARM64)**: `flutterguard-cli-linux-arm64`
-- **macOS (Intel)**: `flutterguard-cli-darwin-amd64`
-- **macOS (Apple Silicon)**: `flutterguard-cli-darwin-arm64`
-- **Windows (x64)**: `flutterguard-cli-windows-amd64.exe`
+**One-line install for Windows (PowerShell):**
 
-**Step 2:** Install it on your system:
+```powershell
+irm https://raw.githubusercontent.com/flutterguard/flutterguard-cli/main/install.ps1 | iex
+```
 
-**On Linux or macOS:**
+The script will automatically detect your OS/architecture, download the latest release, and install it to your PATH.
 
-```bash
-# Download (replace with the URL for your platform)
-curl -LO https://github.com/flutterguard/flutterguard-cli/releases/latest/download/flutterguard-cli-linux-amd64
+---
 
-# Rename to remove platform suffix
-mv flutterguard-cli-linux-amd64 flutterguard-cli
+### Manual Installation
 
-# Make it executable
-chmod +x flutterguard-cli
+<details>
+<summary><b>Option 1: Download Pre-Built Binary</b></summary>
 
-# Move to your PATH (optional, but convenient)
-sudo mv flutterguard-cli /usr/local/bin/
+**Step 1:** Download from [Releases](https://github.com/flutterguard/flutterguard-cli/releases/latest):
+
+| Platform              | Download Link                                                                                                                                      |
+| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Linux (x64)           | [flutterguard-cli-linux-amd64](https://github.com/flutterguard/flutterguard-cli/releases/latest/download/flutterguard-cli-linux-amd64)             |
+| Linux (ARM64)         | [flutterguard-cli-linux-arm64](https://github.com/flutterguard/flutterguard-cli/releases/latest/download/flutterguard-cli-linux-arm64)             |
+| macOS (Intel)         | [flutterguard-cli-darwin-amd64](https://github.com/flutterguard/flutterguard-cli/releases/latest/download/flutterguard-cli-darwin-amd64)           |
+| macOS (Apple Silicon) | [flutterguard-cli-darwin-arm64](https://github.com/flutterguard/flutterguard-cli/releases/latest/download/flutterguard-cli-darwin-arm64)           |
+| Windows (x64)         | [flutterguard-cli-windows-amd64.exe](https://github.com/flutterguard/flutterguard-cli/releases/latest/download/flutterguard-cli-windows-amd64.exe) |
+
+**Step 2:** Install it on your system:
+
+**Linux/macOS:**
+
+```bash
+# Make executable
+chmod +x flutterguard-cli-*
 
-# Verify installation
+# Install to PATH
+sudo mv flutterguard-cli-* /usr/local/bin/flutterguard-cli
+
+# Verify
 flutterguard-cli --version
 ```
 
-**On Windows:**
+**Windows:**
 
-```powershell
-# Download from the releases page, then:
-# 1. Rename flutterguard-cli-windows-amd64.exe to flutterguard-cli.exe
-# 2. Move to a directory in your PATH (e.g., C:\Windows\System32)
-# 3. Or run directly from the download location
+1. Rename the downloaded file to `flutterguard-cli.exe`
+2. Move it to a directory in your PATH (e.g., `C:\Windows\System32`)
+3. Or keep it anywhere and add that directory to your PATH
 
-# Verify installation
+```powershell
+# Verify
 flutterguard-cli.exe --version
 ```
 
-### Option 2: Build From Source
+</details>
 
-If you have Go installed and want the latest features or to contribute to development:
+<details>
+<summary><b>Option 2: Build From Source</b></summary>
 
 **Requirements:**
 
-- Go 1.24 or higher ([Download Go](https://go.dev/dl/))
+- Go 1.24+ ([Download Go](https://go.dev/dl/))
 - Git
 
-**Step 1:** Clone the repository
+**Steps:**
 
 ```bash
+# Clone the repository
 git clone https://github.com/flutterguard/flutterguard-cli.git
 cd flutterguard-cli
-```
 
-**Step 2:** Build the binary
+# Build
+go build -o flutterguard-cli
 
-```bash
-# Build for your current platform
-go build -o build/flutterguard-cli
+# Install (optional)
+sudo mv flutterguard-cli /usr/local/bin/
 
-# The binary will be in the build/ directory
+# Verify
+flutterguard-cli --version
 ```
 
-**Step 3:** (Optional) Install to your PATH
+</details>
 
-```bash
-# On Linux/macOS
-sudo cp build/flutterguard-cli /usr/local/bin/
+<details>
+<summary><b>Option 3: Package Managers</b> (Coming Soon)</summary>
 
-# On Windows (run as Administrator)
-copy build\flutterguard-cli.exe C:\Windows\System32\
-```
+We're working on adding support for popular package managers:
 
-**Step 4:** Verify the installation
+- **Homebrew** (macOS/Linux): `brew install flutterguard-cli`
+- **Snap** (Linux): `snap install flutterguard-cli`
+- **Chocolatey** (Windows): `choco install flutterguard-cli`
+- **AUR** (Arch Linux): `yay -S flutterguard-cli`
+- **Scoop** (Windows): `scoop install flutterguard-cli`
 
-```bash
-flutterguard-cli --version
-```
+Stay tuned for updates!
+
+</details>
 
 ### Optional Tools for Enhanced Analysis
 
diff --git a/install.ps1 b/install.ps1
@@ -0,0 +1,91 @@
+#!/usr/bin/env pwsh
+$ErrorActionPreference = 'Stop'
+
+$repo = "flutterguard/flutterguard-cli"
+$binaryName = "flutterguard-cli.exe"
+$installDir = "$env:LOCALAPPDATA\Programs\FlutterGuard"
+
+Write-Host ""
+Write-Host "🔍 Detecting system..." -ForegroundColor Cyan
+Write-Host "   OS: Windows" -ForegroundColor Gray
+Write-Host "   Architecture: $env:PROCESSOR_ARCHITECTURE" -ForegroundColor Gray
+
+# Determine architecture
+$arch = "amd64"
+if ($env:PROCESSOR_ARCHITECTURE -eq "ARM64") {
+    $arch = "arm64"
+}
+
+$downloadUrl = "https://github.com/$repo/releases/latest/download/flutterguard-cli-windows-$arch.exe"
+
+Write-Host ""
+Write-Host "📥 Downloading FlutterGuard CLI..." -ForegroundColor Cyan
+Write-Host "   From: $downloadUrl" -ForegroundColor Gray
+
+try {
+    # Download with progress
+    $ProgressPreference = 'SilentlyContinue'  # Faster downloads
+    Invoke-WebRequest -Uri $downloadUrl -OutFile $binaryName -UseBasicParsing
+    $ProgressPreference = 'Continue'
+    Write-Host "   ✓ Downloaded successfully" -ForegroundColor Green
+} catch {
+    Write-Host ""
+    Write-Host "❌ Download failed: $_" -ForegroundColor Red
+    Write-Host "   Please check:" -ForegroundColor Yellow
+    Write-Host "   1. Your internet connection" -ForegroundColor Yellow
+    Write-Host "   2. The release exists: https://github.com/$repo/releases/latest" -ForegroundColor Yellow
+    exit 1
+}
+
+Write-Host ""
+Write-Host "📦 Installing..." -ForegroundColor Cyan
+
+# Create installation directory
+try {
+    New-Item -ItemType Directory -Force -Path $installDir | Out-Null
+    Move-Item -Force $binaryName "$installDir\$binaryName"
+    Write-Host "   ✓ Installed to $installDir" -ForegroundColor Green
+} catch {
+    Write-Host "   ⚠️  Failed to move to $installDir" -ForegroundColor Yellow
+    Write-Host "   Binary is in current directory: .\$binaryName" -ForegroundColor Yellow
+    Write-Host ""
+    Write-Host "To install manually:" -ForegroundColor Yellow
+    Write-Host "   Move-Item $binaryName $installDir\" -ForegroundColor Gray
+    exit 0
+}
+
+# Add to PATH if not already there
+Write-Host "   Updating PATH..." -ForegroundColor Gray
+try {
+    $currentPath = [Environment]::GetEnvironmentVariable("Path", "User")
+    if ($currentPath -notlike "*$installDir*") {
+        [Environment]::SetEnvironmentVariable("Path", "$currentPath;$installDir", "User")
+        Write-Host "   ✓ Added to PATH (restart terminal to use)" -ForegroundColor Green
+        $env:Path = "$env:Path;$installDir"  # Update current session
+    } else {
+        Write-Host "   ✓ Already in PATH" -ForegroundColor Green
+    }
+} catch {
+    Write-Host "   ⚠️  Could not update PATH automatically" -ForegroundColor Yellow
+    Write-Host "   Please add manually: $installDir" -ForegroundColor Yellow
+}
+
+# Verify installation
+Write-Host ""
+Write-Host "🎉 Installation complete!" -ForegroundColor Green
+Write-Host ""
+
+try {
+    $version = & "$installDir\$binaryName" --version 2>&1
+    Write-Host "✓ Version: $version" -ForegroundColor Green
+} catch {
+    Write-Host "✓ Installed to: $installDir\$binaryName" -ForegroundColor Green
+}
+
+Write-Host ""
+Write-Host "Try it out:" -ForegroundColor Cyan
+Write-Host "  flutterguard-cli --help" -ForegroundColor Gray
+Write-Host "  flutterguard-cli --apk your-app.apk" -ForegroundColor Gray
+Write-Host ""
+Write-Host "Note: If command not found, restart your terminal or run:" -ForegroundColor Yellow
+Write-Host "  `$env:Path = `"$env:Path;$installDir`"" -ForegroundColor Gray
diff --git a/install.sh b/install.sh
@@ -0,0 +1,120 @@
+#!/usr/bin/env bash
+set -e
+
+REPO="flutterguard/flutterguard-cli"
+BINARY_NAME="flutterguard-cli"
+INSTALL_DIR="/usr/local/bin"
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+# Detect OS and architecture
+OS=$(uname -s | tr '[:upper:]' '[:lower:]')
+ARCH=$(uname -m)
+
+echo "🔍 Detecting system..."
+echo "   OS: $OS"
+echo "   Architecture: $ARCH"
+
+# Map architecture to Go arch naming
+case "$ARCH" in
+    x86_64) ARCH="amd64" ;;
+    aarch64|arm64) ARCH="arm64" ;;
+    armv7l) ARCH="arm" ;;
+    i386|i686) ARCH="386" ;;
+    *) 
+        echo -e "${RED}❌ Unsupported architecture: $ARCH${NC}"
+        echo "   Supported: x86_64, aarch64, arm64, armv7l, i386, i686"
+        exit 1
+        ;;
+esac
+
+# Check OS support
+case "$OS" in
+    linux|darwin) ;;
+    mingw*|msys*|cygwin*) 
+        echo -e "${RED}❌ Please use install.ps1 for Windows${NC}"
+        echo "   Run: irm https://raw.githubusercontent.com/$REPO/main/install.ps1 | iex"
+        exit 1
+        ;;
+    *) 
+        echo -e "${RED}❌ Unsupported OS: $OS${NC}"
+        echo "   Supported: Linux, macOS"
+        exit 1
+        ;;
+esac
+
+# Construct download URL
+DOWNLOAD_URL="https://github.com/$REPO/releases/latest/download/${BINARY_NAME}-${OS}-${ARCH}"
+
+echo ""
+echo "📥 Downloading FlutterGuard CLI..."
+echo "   From: $DOWNLOAD_URL"
+
+# Download with progress
+if command -v curl &> /dev/null; then
+    curl -fL --progress-bar "$DOWNLOAD_URL" -o "$BINARY_NAME" || {
+        echo -e "${RED}❌ Download failed. Please check:${NC}"
+        echo "   1. Your internet connection"
+        echo "   2. The release exists: https://github.com/$REPO/releases/latest"
+        exit 1
+    }
+elif command -v wget &> /dev/null; then
+    wget --show-progress -O "$BINARY_NAME" "$DOWNLOAD_URL" || {
+        echo -e "${RED}❌ Download failed. Please check:${NC}"
+        echo "   1. Your internet connection"
+        echo "   2. The release exists: https://github.com/$REPO/releases/latest"
+        exit 1
+    }
+else
+    echo -e "${RED}❌ Neither curl nor wget found. Please install one of them.${NC}"
+    exit 1
+fi
+
+# Make executable
+chmod +x "$BINARY_NAME"
+
+echo ""
+echo "📦 Installing..."
+
+# Try to install to /usr/local/bin
+if [ -w "$INSTALL_DIR" ]; then
+    mv "$BINARY_NAME" "$INSTALL_DIR/"
+    echo -e "${GREEN}✅ Installed to $INSTALL_DIR/$BINARY_NAME${NC}"
+elif command -v sudo &> /dev/null; then
+    echo "   (requires sudo for $INSTALL_DIR)"
+    sudo mv "$BINARY_NAME" "$INSTALL_DIR/" || {
+        echo -e "${YELLOW}⚠️  Failed to install to $INSTALL_DIR${NC}"
+        echo "   Binary is in current directory: ./$BINARY_NAME"
+        echo "   To install manually:"
+        echo "   sudo mv $BINARY_NAME $INSTALL_DIR/"
+        exit 0
+    }
+    echo -e "${GREEN}✅ Installed to $INSTALL_DIR/$BINARY_NAME${NC}"
+else
+    echo -e "${YELLOW}⚠️  Cannot write to $INSTALL_DIR and sudo not available${NC}"
+    echo "   Binary downloaded to: ./$BINARY_NAME"
+    echo "   To install manually:"
+    echo "   sudo mv $BINARY_NAME $INSTALL_DIR/"
+    exit 0
+fi
+
+# Verify installation
+echo ""
+echo "🎉 Installation complete!"
+echo ""
+
+if command -v "$BINARY_NAME" &> /dev/null; then
+    VERSION=$("$BINARY_NAME" --version 2>&1 || echo "unknown")
+    echo -e "${GREEN}✓${NC} Version: $VERSION"
+    echo ""
+    echo "Try it out:"
+    echo "  $BINARY_NAME --help"
+    echo "  $BINARY_NAME --apk your-app.apk"
+else
+    echo -e "${YELLOW}⚠️  Binary installed but not in PATH${NC}"
+    echo "   You may need to restart your terminal or add $INSTALL_DIR to PATH"
+fi
