ItamiForge
ProjectsDevice Finder

Installation & Setup

Install Device Finder via crates.io or build from source.

Installation & Setup

Device Finder is published to crates.io and can be installed with a single cargo install command.

Prerequisites

Required

  • Rust (1.70+ recommended)
  • Cargo (included with Rust)

Platform-Specific

macOS (for iOS support):

  • Xcode with Command Line Tools (xcode-select --install)
  • xcrun available in PATH

Android (all platforms):

  • Android SDK with adb in PATH
  • Installation: brew install android-platform-tools (macOS) or Android SDK

All platforms:

  • Terminal with Unicode support (for nice rendering)

Install

cargo install device-finder

This installs the df binary to ~/.cargo/bin/df. Ensure ~/.cargo/bin is in your PATH.

From GitHub (latest unreleased)

cargo install --git https://github.com/ItamiForge/device-finder.git

From local source

git clone https://github.com/ItamiForge/device-finder.git
cd device-finder
cargo install --path .

Verify

df --version
# df 0.1.0

df list
# Lists all installed simulators, emulators, and connected devices

Setup by Platform

macOS

  1. Install Xcode Command Line Tools (if not already installed):

    xcode-select --install
  2. Install Android SDK tools (optional, for Android support):

    brew install android-platform-tools
    adb version  # Verify
  3. Install Device Finder:

    cargo install device-finder
  4. Verify:

    df list

Linux

  1. Install Android SDK tools:

    # Ubuntu/Debian
    sudo apt install android-tools-adb
    
    # Arch
    sudo pacman -S android-tools
    
    # Fedora
    sudo dnf install android-tools
  2. Install Rust (if not already installed):

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  3. Install Device Finder:

    cargo install device-finder

Windows

  1. Install Rust: Download and run rustup-init.exe

  2. Install Android SDK (optional):

  3. Install Device Finder:

    cargo install device-finder

Configuration (Optional)

Create ~/.config/itamiforge/device-finder/config.toml:

[platforms]
# Filter devices by platform on startup
default_filter = ["ios", "android"]

# Exclude specific devices
exclude_devices = ["old-simulator"]

[tools]
# Override tool paths if they're not in PATH
adb_path = "/opt/android-sdk/platform-tools/adb"
xcrun_path = "/Applications/Xcode.app/Contents/Developer/usr/bin/xcrun"

Troubleshooting

df: command not found

Ensure ~/.cargo/bin is in your PATH:

echo $PATH | grep ".cargo/bin"

If not, add it to your shell profile (~/.bashrc, ~/.zshrc, etc.):

export PATH="$HOME/.cargo/bin:$PATH"

xcrun: command not found (macOS)

Install Xcode Command Line Tools:

xcode-select --install

adb: command not found (Android)

Ensure Android Platform Tools are installed:

# macOS
brew install android-platform-tools

# Linux
sudo apt install android-tools-adb

# Verify
adb version

No devices detected

  1. Ensure tools are installed and in PATH
  2. For iOS: Start a simulator first (xcrun simctl boot <device-id>)
  3. For Android: Connect device via USB or start an emulator
  4. Check permissions: Device may need USB debugging enabled

Building from Source

git clone https://github.com/ItamiForge/device-finder.git
cd device-finder

# Debug build
cargo build

# Release build (optimized)
cargo build --release

# Binary location
./target/release/df --version

Updating

Update to the latest version from crates.io:

cargo install device-finder --force

Or from local source:

cd device-finder
git pull
cargo install --path . --force

Uninstall

cargo uninstall device-finder

Next Steps