Installation and Requirements

Download and Install

  1. Check the requirements below.
  2. Download and install Xamarin Workbooks for Mac (or download for Windows).
  3. Start playing around with workbooks or try out the samples.

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 App Platforms

App Platform OS Support Notes
Mac (Unified) Only supported on Mac
iOS (Unified) Supported on Mac and Windows
  • Xamarin Studio 6.1 or greater, Xamarin.iOS, and Xcode 8.1 or greater must be installed on Mac.
  • Running iOS workbooks on Windows requires a Mac build host running all of the above, and Xamarin Workbooks installed there as well.
Android Supported on Mac and Windows Must use Google, Visual Studio or Xamarin Android emulator, with a virtual device >= 5.0
WPF Only supported on Windows
Console Supported on Mac and Windows

Reporting Bugs

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

Log Files

Always attach Workbooks client log files:

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

Platform Version Information

It is very helpful to know details about your Operating System and installed Xamarin products.

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.

Samples

If you can attach or link to the .workbooks file you are having trouble with, that might help solve your bug more quickly.

Devices

If you are having trouble connecting your iOS or Android workbook, and have already checked our troubleshooting page, we'll need to know:

  • Name of device you are trying to connect to
  • 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?
  • iOS on Windows: What version of the Xamarin Remote iOS Simulator do you have installed (check Add/Remove Programs in Control Panel)?
  • iOS on Windows: Please also provide Platform Version Information for your Mac build host
  • 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.