If at any point you would like some help, join us in Slack! You'll find members of the AppMap team there, along with other AppMap users.

Add AppMap to a project

Install the AppMap extension for your code editor

AppMap for Visual Studio Code

The AppMap extension is listed on the Visual Studio Code Marketplace.

  1. Open extensions from the sidebar in Visual Studio Code
  2. Type ‘AppMap’ into the search bar
  3. Click to install

Install from the VS Code Marketplace

AppMap for JetBrains IDEs

The AppMap plugin has official support for IntelliJ, PyCharm, and RubyMine listed on the JetBrains Marketplace.

  1. Start your JetBrains IDE and open Preferences
  2. Open Plugins / Marketplace
  3. Search for AppMap, select and install AppMap

Install from the JetBrains Marketplace

AppMap for GitHub Actions

Configure AppMap in your CI system or using GitHub Actions to continually analyze code changes during a pull request. AppMap will identify runtime code quality issues, performance issues, and security issues in your Pull Request before you merge. Refer to the Runtime Analysis - In CI documentation to learn how to integrate AppMap into your CI system or GitHub Actions for continual runtime code analysis.

Request early access to our GitHub integration

IntelliJ Run Configurations for Java

If you’re programming in Java using IntelliJ, you can make AppMaps using the extension command “Start with AppMap”. These custom buttons and menu options can be used to run your Java application code with AppMap automatically configured.

See AppMap for JetBrains - Start with AppMap for more information.

VS Code Launch Configurations for Java

If you’re programming in Java using VS Code, you can make AppMaps using the Java Launch Configurations command “Run with AppMap”.

See AppMap for VS Code - Run with AppMap for more information.

Advanced Installation Options

To make AppMaps, you’ll need to install and configure the AppMap client library for your programming language. The AppMap client library is a package (Ruby gem, Python / JavaScript / Java package) that you install using your dependency manager (Rubygems, Pip, Npm, Yarn, Maven, Gradle, etc).

The easiest way to get setup is to use the the command-line installation and configuration utility.

AppMap publishes binaries of the command-line installer for various operating systems, you can find the most recent version of the AppMap command-line installer on GitHub. Expand the “Assets” section to find binaries for Windows, Mac, and Linux.

After you install the CLI, refer to the installation documentation to learn how to install AppMap into your project.

You can also follow the manual installation procedure specific to your language below.

Was this page helpful? thumb_up Yes thumb_down No
Thank you for your feedback!