Skip to content

Latest commit

 

History

History
213 lines (152 loc) · 4.17 KB

INSTALL.md

File metadata and controls

213 lines (152 loc) · 4.17 KB

Installation Guide

Quick Install

macOS (Homebrew) - Recommended

# Add tap
brew tap thanhdevapp/tools

# Install
brew install dev-cleaner

# Verify
dev-cleaner --version

Update to latest version:

brew update
brew upgrade dev-cleaner

One-Line Installer (macOS & Linux)

Automatic installation:

curl -fsSL https://raw.githubusercontent.com/thanhdevapp/mac-dev-cleaner-cli/dev-mvp/install.sh | bash

What it does:

  • Detects your OS and architecture automatically
  • Downloads the latest release binary
  • Installs to /usr/local/bin/
  • Verifies installation

Manual review before running:

# View the script first
curl -fsSL https://raw.githubusercontent.com/thanhdevapp/mac-dev-cleaner-cli/dev-mvp/install.sh

# Then run it
curl -fsSL https://raw.githubusercontent.com/thanhdevapp/mac-dev-cleaner-cli/dev-mvp/install.sh | bash

Note: After migrating to main branch (see BRANCHING_STRATEGY.md), URLs will use /main/ instead of /dev-mvp/

Download Binaries

Latest Release: v1.0.1

macOS

Apple Silicon (M1/M2/M3)

# Download
curl -L https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/download/v1.0.1/dev-cleaner_1.0.1_darwin_arm64.tar.gz -o dev-cleaner.tar.gz

# Extract
tar -xzf dev-cleaner.tar.gz

# Install to PATH
sudo mv dev-cleaner /usr/local/bin/

# Verify
dev-cleaner --version

Intel

# Download
curl -L https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/download/v1.0.1/dev-cleaner_1.0.1_darwin_amd64.tar.gz -o dev-cleaner.tar.gz

# Extract
tar -xzf dev-cleaner.tar.gz

# Install to PATH
sudo mv dev-cleaner /usr/local/bin/

# Verify
dev-cleaner --version

Linux

ARM64

curl -L https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/download/v1.0.1/dev-cleaner_1.0.1_linux_arm64.tar.gz -o dev-cleaner.tar.gz
tar -xzf dev-cleaner.tar.gz
sudo mv dev-cleaner /usr/local/bin/
dev-cleaner --version

AMD64

curl -L https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/download/v1.0.1/dev-cleaner_1.0.1_linux_amd64.tar.gz -o dev-cleaner.tar.gz
tar -xzf dev-cleaner.tar.gz
sudo mv dev-cleaner /usr/local/bin/
dev-cleaner --version

Build from Source

Prerequisites

  • Go 1.21 or higher
  • Git

Steps

# Clone repository
git clone https://github.com/thanhdevapp/mac-dev-cleaner-cli.git
cd mac-dev-cleaner-cli

# Build CLI
go build -o dev-cleaner ./cmd/dev-cleaner

# Install to PATH
sudo mv dev-cleaner /usr/local/bin/

# Verify
dev-cleaner --version

Build GUI (Wails)

# Install dependencies
cd frontend
npm install
npm run build
cd ..

# Build GUI app
wails build

# Run
./build/bin/Mac\ Dev\ Cleaner.app/Contents/MacOS/Mac\ Dev\ Cleaner

Verify Installation

After installation, verify the tool works:

# Check version
dev-cleaner --version
# Expected output: dev-cleaner version 1.0.1

# Run help
dev-cleaner --help

# Test scan (dry-run)
dev-cleaner scan --help

All Releases

View all releases: GitHub Releases

Uninstall

Homebrew

brew uninstall dev-cleaner
brew untap thanhdevapp/tools

Manual Install

sudo rm /usr/local/bin/dev-cleaner
rm ~/.dev-cleaner.log  # Optional: remove log file

Troubleshooting

"command not found: dev-cleaner"

  • Check if /usr/local/bin is in your PATH
  • Try: echo $PATH | grep /usr/local/bin
  • Add to PATH if needed: export PATH="/usr/local/bin:$PATH"

"permission denied"

  • Run with sudo: sudo mv dev-cleaner /usr/local/bin/
  • Or install to user directory: mv dev-cleaner ~/bin/

Homebrew: "Xcode version outdated"

  • This is a warning, not an error
  • Installation still works
  • Alternatively, use direct download method

Support