Documentation

How to Use UIScope

From first install to generating automation code — everything you need to get productive in minutes.

Installation

Windows (recommended — Microsoft Store)

The easiest way to install UIScope on Windows is the Microsoft Store. Updates are automatic.

Get UIScope on Microsoft Store

Windows (direct download)

  1. Download the .exe installer from GitHub Releases
  2. Double-click the installer — no admin rights required (per-user install)
  3. UIScope appears in the Start menu and system tray

Enterprise / silent install options: .msi via msiexec /i UIScope.msi /qn, or .msix for WinGet / sideload.

Linux (Ubuntu / Debian)

sudo dpkg -i uiscope_*.deb

Or download the .AppImage for a portable, no-install option:

chmod +x UIScope-*.AppImage
./UIScope-*.AppImage

macOS

Build from source — see the GitHub repository for instructions.

Android inspection additionally requires ADB (Android Debug Bridge) in your system PATH. UIScope can detect if ADB is missing and will guide you through installing it from the onboarding screen.

First Launch & Onboarding

The first time you open UIScope you will see the Onboarding screen, which checks your environment:

1

ADB check

UIScope looks for adb in your PATH. If it is missing, a one-click button downloads the minimal Android Platform Tools (~10 MB) and installs them for you.

2

OS accessibility check

On macOS, UIScope requires the Accessibility permission — you will be shown the exact system preference pane to enable it. On Windows and Linux this is automatic.

3

Launcher

Once checks pass, the Launcher screen lets you pick between PC Inspector, Android Inspector, Diff Mode, and Watch Mode. UIScope remembers your last-used mode.

Android Inspector

Connect via USB

1

Enable USB Debugging

On your Android device: Settings → About phone → tap Build number seven times → go back to Settings → Developer options → enable USB Debugging.

2

Plug in the USB cable

Connect the device to your PC. Accept the "Allow USB Debugging" dialog on the device if prompted.

3

Select the device in UIScope

Open UIScope → Android Inspector. Your device appears in the device list within a few seconds. Click it to connect.

4

Capture & inspect

UIScope takes a screenshot and dumps the full UI tree. Navigate to any screen on the device and press Refresh (or Alt+Shift+R) to re-capture.

Connect wirelessly (Android 11+)

  1. On the device: Developer options → Wireless Debugging → enable it → tap Pair device with pairing code
  2. In UIScope: click Pair wirelessly and enter the 6-digit code and port shown on the device
  3. After pairing succeeds, the device appears in the list — select it to connect

Connect wirelessly (pre-Android 11)

  1. Connect via USB first, then run adb tcpip 5555 in a terminal
  2. Unplug the USB cable
  3. In UIScope: click Connect via IP and enter the device's IP address

Navigating the inspector

The Android inspector has three panels:

Bidirectional selection: click a node in the tree → it highlights on the canvas; click the canvas → the corresponding node is selected in the tree.

PC Inspector

PC Inspector works on Windows (UIAutomation), macOS (AX API), and Linux (AT-SPI2). No additional software is required — UIScope uses the OS accessibility APIs directly via JNA.

Using Pick Mode

1

Open PC Inspector

From the Launcher, select PC Inspector. UIScope starts in pick mode automatically.

2

Hover over a window

Move your cursor over any window — a blue highlight overlay shows the element currently under your cursor.

3

Lock with Alt+Shift+P

Press Alt+Shift+P to lock onto the window. UIScope captures the full element tree for that process and loads it into the inspector.

4

Explore the tree

The same 3-panel layout as Android Inspector: tree on the left, canvas in the centre, properties on the right. Scroll and expand nodes, click to select, use Ctrl+F to search.

Tip: You can press Alt+Shift+P from anywhere — even while UIScope is in the background. The global hotkey works system-wide.

Code Generation

With any node selected in the tree, open the Code tab in the Properties panel to see ready-to-paste automation code.

Supported frameworks

FrameworkPlatformLanguage
AutoHotKey v2Windows PCAHK
pywinautoWindows PCPython
FlaUIWindows PCC#
PowerShell UIAutomationWindows PCPowerShell
uiautomator2AndroidPython
UIAutomator2AndroidKotlin / Java
AppiumAndroidJava & Python
MaestroAndroidYAML
XPathAndroid & PCXPath expression

Fragile selector warnings

UIScope analyses each generated selector and shows a yellow "Fragile" badge if the selector is likely to break. Common fragility signals include:

The badge includes an explanation of why the selector is fragile and a suggestion for how to make it more stable.

Diff Mode

Diff Mode compares two saved inspection sessions and shows exactly what changed between them.

1

Save two sessions

Every capture is saved automatically. If you want to compare before/after a code change, just inspect twice — once before and once after.

2

Open Diff Mode

From the Launcher (or menu bar), choose Diff Mode. Pick the two sessions you want to compare from the dropdown lists.

3

Review the diff

The diff view shows three columns: added elements, removed elements, and changed elements. Expand any changed element to see the exact property differences.

Watch Mode

Watch Mode monitors a connected Android device continuously and fires a notification when a condition you define is met.

Creating a watch rule

  1. Open Watch Mode from the Launcher
  2. Select your connected Android device
  3. Click Add Rule and choose a condition type:
    • Element appears — fires when a node matching a selector appears in the tree
    • Element disappears — fires when a matching node is no longer present
    • Text matches — fires when a node's text equals or contains a given string
    • Text changes — fires whenever a node's text value changes
  4. Set the selector (resource ID, text, XPath, or class name)
  5. Click Start Watching

When the condition is met, UIScope shows a desktop notification and logs the event in the Watch log panel. You can run multiple rules simultaneously.

Export & Sessions

Exporting the element tree

With an inspection open, click the Export button (or File → Export) and choose a format:

FormatBest for
JSONScripts, diffing with external tools, machine processing
XMLUIAutomator-compatible output; works with Appium, other tools
OutlineHuman-readable indented tree — great for bug reports and documentation

You can export the entire tree or just the currently selected subtree.

Session history

All sessions are stored automatically in ~/.uiscope/uiscope.db. Open the History screen to:

Keyboard Shortcuts

Alt+Shift+P Pick lock (PC inspector, global)
Alt+Shift+R Refresh capture
Ctrl+F Search tree
Ctrl+Shift+N New window
Ctrl+W Close window
Ctrl+Q Quit UIScope
/ Navigate tree nodes
/ Collapse / expand node

Tips & Tricks