Skip to main content

Getting started

Get running with Runabout in under 5 minutes.

Installation​

What you'll need​

  • To install Runabout, you must have IntellJ IDEA installled. Find it here.
    • Must use IntelliJ 2022.2 or newer
    • Runabout works for both the Community and Ultimate editions

Installing the plugin​

Within your IDE go to the main menu and select: Settings
On the left side of the dialog select: Plugins

Search for "Runabout" and select install. The IDE may request that you restart the application before using the plugin.

Runabout Installation

Create an account​

Runabout accounts are free to create and give you access to more useful features!

To create an account visit runabout.dev and click on the Sign Up button.

Runabout Sign Up

Get your API key​

To use your Runabout account within the plugin, you need to get your API key. Runabout provides every user with exactly one API key at a time.

Don't worry if you lose it, you can always regenerate a new one and invalidate the old one.

To get a new API key, login to Runabout and go to settings.

  1. Click on the button that says Get new API key

Get new API key

  1. Copy the key from the popup

Copy API key

  1. Go to the Intellij IDEA IDE
  2. From the main menu bar at the top go to Tools > Runabout > Runabout Settings

Go to settings

  1. In the popup, paste your Client-Id (found on the settings page) and API key. Settings popup