Installation and Requirements

Download and Installation

  1. Download and install the Xamarin Workbooks & Inspector for Mac (or download for Windows).

  2. Inspect your own app!

Requirements

Supported Operating Systems

  • Mac - OS X 10.11 or greater
  • Windows - Windows 7 or greater (with Internet Explorer 11 or greater and .NET 4.6 or greater)

Supported IDEs

  • Xamarin Studio 6.2 or greater
  • Visual Studio for Mac Preview 4 or greater
  • Visual Studio 2015 with Xamarin 4.3.x or greater
  • Visual Studio 2017 with Xamarin workload

Live app inspection is available for enterprise customers.

Supported App Platforms

App Platform IDE Support Notes
Mac (Unified) Only supported on Mac
iOS (Unified) Supported in XS and Visual Studio Inspecting iOS apps from Windows requires the same version of Inspector to also be installed on the Mac build host.
Android Supported in XS and Visual Studio
  • Must target Android >= 4.0.3
  • Must have fastdev enabled
  • Must use Google, Visual Studio, or Xamarin Android emulators. Android 7 emulators may not allow inspection at this time.
WPF Only supported in Visual Studio on Windows

Reporting Bugs

Please report bugs to bugzilla, and include all of the following information:

Platform Version Information

This information is vital.

Visual Studio For Mac

  • Visual Studio > About Visual Studio > Show Details > Copy Information
  • Paste into bug report

Xamarin Studio

  • Xamarin Studio > About Xamarin Studio > Show Details > Copy Information
  • Paste into bug report

Visual Studio

  • Help > About Visual Studio > Copy Info
  • Let us know your Operating System version and whether you are running 32-bit or 64-bit Windows.

Log Files

Always attach both IDE and Inspector client log files.

Inspector client

  • Mac: ~/Library/Logs/Xamarin/Inspector/Xamarin Inspector {date}.log
  • Windows: %LOCALAPPDATA%\Xamarin\Inspector\logs\Xamarin Inspector {date}.log

Visual Studio For Mac

  • ~/Library/Logs/VisualStudio/7.0/Ide.log

Xamarin Studio

  • ~/Library/Logs/XamarinStudio-6.0/Ide.log

Visual Studio

  • %LOCALAPPDATA%\Xamarin\Logs\{VS version}\Inspector {date}.log
  • The contents of the Visual Studio Output pane may also be informative.

Project Settings

If you can attach the .csproj for the project you are trying to inspect, it would be extremely helpful. This is easier than asking about individual settings.

Also please confirm that you are in Debug configuration.

Selected Devices

For Android and iOS, it is vital that we know what device you are debugging on when you want to inspect. We need to know:

  • Name of device as shown in your IDE
  • OS version of your device
  • Android: Verify that you are using an x86 emulator
  • Android: What emulator platform are you using? Google Emulator? Visual Studio Android Emulator? Xamarin Android Player?
  • Does the app you are debugging properly appear and function in the device?
  • Does the device have network connectivity (check via web browser)?

Uninstall

Windows

Depending on how you acquired Workbooks & Inspector, you may have to perform two uninstallation procedures. Please check both of these to completely uninstall the software.

Visual Studio Installer

If you have Visual Studio 2017, open "Visual Studio Installer", and look in "Individual Components" for "Xamarin Workbooks". If it is checked, uncheck it and then click "Modify" to uninstall.

System Uninstall

If you installed Workbooks & Inspector yourself with a downloaded installer, it will need to be uninstalled via the "Apps & features" system settings page on Windows 10 or via "Add/Remove Programs" in the Control Panel on older versions of Windows.

Start → Settings → System → Apps & features

You should still follow the procedure for the Visual Studio Installer to make sure Workbooks & Inspector does not get reinstalled without your knowledge.

macOS

Starting with 1.2.2, Xamarin Workbooks & Inspector can be uninstalled from a terminal by running:

sudo /Library/Frameworks/Xamarin.Interactive.framework/Versions/Current/uninstall

The uninstaller will detail the files and directories it will remove and ask for confirmation before proceeding.

Pass the -help argument to the uninstall script for more advanced scenarios.

For older versions, you will need to manually remove the following:

  1. Delete the Workbooks app at "/Applications/Xamarin Workbooks.app"
  2. Delete the Inspector app at "Applications/Xamarin Inspector.app"
  3. Delete the add-ins: "~/Library/Application Support/XamarinStudio-6.0/LocalInstall/Addins/Xamarin.Interactive" and "~/Library/Application Support/XamarinStudio-6.0/LocalInstall/Addins/Xamarin.Inspector"
  4. Delete Inspector and supporting files here: /Library/Frameworks/Xamarin.Interactive.framework and /Library/Frameworks/Xamarin.Inspector.framework

Xamarin Workbook

If it's not already installed, install the Xamarin Workbooks app first. The workbook file should download automatically, but if it doesn't, just click to start the workbook download manually.