Stay organized with collections
Save and categorize content based on your preferences.
This document describes how to migrate your IntelliJ-based App Engine project
to Cloud Code for IntelliJ.
Before you begin
If your project is Maven or Gradle based and uses the older
App Engine SDK based plugins (e.g.
com.google.appengine.appengine-maven-plugin and
com.google.appengine:gradle-appengine-plugin), you should first migrate to
the new gcloud CLI based
Maven
and
Gradle
plugins.
The new plugin does not support Datanucleus enhancement. If you depend on
this feature, you will have to manually configure Datanucleus
(JDO,
JPA)
enhancement for your project to migrate to Cloud Code.
You should use
Objectify
as your ORM layer when reading/writing to Datastore.
Install the new plugin
If you haven't already, install the plugin by doing the following:
Ensure you have the supported IDE version, JetBrains IDE version 2022.3+
(such as IntelliJ Ultimate/Community, PyCharm Professional/Community,
WebStorm, GoLand), on the PATH of your machine.
Open IntelliJ IDEA (or any supported JetBrains IDE).
Open the plugins marketplace window using File > Settings >
Plugins. For Mac OS X, use IntelliJ IDEA > Preferences >
Plugins.
Search for the 'Cloud Code' plugin and install it.
You may be prompted to restart your IDE to activate the plugin.
Configure IntelliJ and your project
After installing the plugin, configure IntelliJ and your project to use the new
plugin as follows:
When notified that the new plugin conflicts with the existing
App Engine integration, click the link in the prompt.
In the following Disable Plugin prompt, select 'Disable and Restart' to
disable the App Engine plugin and restart the IDE for the plugin
configuration changes to take effect.
When notified that your project is in an old format, click the option to
Convert your project to the new format.
You should delete your existing App Engine Server and Cloud
instances and recreate them using the new gcloud CLI.
Navigate to Settings > Build, Execution, Deployment >
Application Servers.
Select your App Engine Dev instances and click
Delete (-).
Click Add (+) and select Google App Engine Dev Server.
Navigate to Settings > Build, Execution, Deployment >
Clouds.
Select your Google App Engine cloud instances and click
Delete (-).
Click Add (+) to configure an App Engine cloud deployment
target.
If you have any App Engine local server run configurations, then
you must update them to use the newly configured Application Server.
Navigate to Tools > Cloud Code > App Engine to see the list of actions
available to you for running and deploying your application, or view
the documentation for more information.
For Maven or Gradle-based projects, ensure that you are using the latest
version of the Gradle and Maven App Engine plugins.
Configuring IntelliJ-specific projects
For IntelliJ-specific projects only (i.e., projects that have manually configured
project settings with the old App Engine facet and are not synced from
Gradle or Maven), update your App Engine dependencies.
Your App Engine dependencies are still configured as
'External Libraries' and provided by your old App Engine SDK
installation. If you delete your App EngineSDK installation, your
application will not compile.
To remove this dependency on the old App Engine SDK, configure your
App Engine API dependencies using the App Engine Facet
library import feature as follows:
Users of the old plugin's Datanucleus JDO/JPA enhancement feature need to
port their applications to Maven or Gradle as Datanucleus enhancement is not
supported by the Cloud Code plugin.
From the IntelliJ Project Structure UI, navigate to your App Engine
Standard module's dependencies tab.
Remove all App Engine related libraries.
In the same Project Structure UI, navigate to your App Engine
module's Google App Engine facet.
In the Libraries panel, select the App Engine dependencies you
are using.
This action will automatically retrieve these dependencies from Maven
Central and add them to your module classpath.
Run locally and deploy to verify your new configuration is working.
At this point, you can safely delete your old App Engine SDK.
Get support
To submit feedback or report an issue in your IntelliJ IDE, go to
Tools > Cloud Code > Help / About > Submit
feedback or report an issue to report an issue on GitHub.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis guide explains the process of migrating App Engine projects from IntelliJ to Cloud Code for IntelliJ, focusing on necessary configurations and plugin installations.\u003c/p\u003e\n"],["\u003cp\u003eCloud Code supports Java 8 runtimes, but due to the impending deprecation of Java 8 support for App Engine, it is disabled by default and creating new App Engine projects is discouraged.\u003c/p\u003e\n"],["\u003cp\u003eBefore migrating, Maven or Gradle projects using older App Engine SDK plugins should switch to the new gcloud CLI-based plugins, as well as migrate from Datanucleus enhancement.\u003c/p\u003e\n"],["\u003cp\u003eUsers must install the Cloud Code plugin, disable the old App Engine plugin, convert their project format, delete old App Engine server and cloud instances, and ensure they use the latest version of Gradle and Maven App Engine plugins.\u003c/p\u003e\n"],["\u003cp\u003eIntelliJ-specific projects must remove old App Engine SDK dependencies and use the App Engine Facet library import feature to retrieve necessary dependencies from Maven Central, allowing for deletion of the old App Engine SDK.\u003c/p\u003e\n"]]],[],null,["# Migrate to Cloud Code for IntelliJ\n\nThis document describes how to migrate your IntelliJ-based App Engine project\nto Cloud Code for IntelliJ.\n| **Caution:** As of January 31, 2024, Java 8 support for App Engine has ended, and will be deprecated on January 31, 2026. As a result, Cloud Code disables App Engine by default. To enable App Engine in your IDE, navigate to **Settings** \\\u003e **Google\n| Cloud Code** \\\u003e **App Engine** . Due to the upcoming deprecation of App Engine, we don't recommend creating new App Engine projects. For more information about App Engine deprecations, see [Feature deprecations](/appengine/docs/standard/deprecations). For more information about the runtime support schedule for App Engine, see [Runtime support schedule](/appengine/docs/standard/lifecycle/support-schedule).\n\nBefore you begin\n----------------\n\n- If your project is Maven or Gradle based and uses the older\n App Engine SDK based plugins (e.g.\n `com.google.appengine.appengine-maven-plugin` and\n `com.google.appengine:gradle-appengine-plugin`), you should first migrate to\n the new gcloud CLI based\n [Maven](/appengine/docs/standard/java/tools/migrate-maven)\n and\n [Gradle](/appengine/docs/standard/java/tools/migrate-gradle)\n plugins.\n\n- The new plugin does not support Datanucleus enhancement. If you depend on\n this feature, you will have to manually configure Datanucleus\n ([JDO](/appengine/docs/standard/java/datastore/jdo/overview-dn2),\n [JPA](/appengine/docs/standard/java/datastore/jpa/overview-dn2))\n enhancement for your project to migrate to Cloud Code.\n You should use\n [Objectify](/appengine/docs/legacy/standard/java/datastore#using_objectify_with)\n as your ORM layer when reading/writing to Datastore.\n\nInstall the new plugin\n----------------------\n\nIf you haven't already, install the plugin by doing the following:\n\n- Ensure you have the supported IDE version, JetBrains IDE version 2022.3+ (such as IntelliJ Ultimate/Community, PyCharm Professional/Community, WebStorm, GoLand), on the `PATH` of your machine.\n- Open IntelliJ IDEA (or any supported JetBrains IDE).\n- Open the plugins marketplace window using **File** \\\u003e **Settings** \\\u003e **Plugins** . For Mac OS X, use **IntelliJ IDEA** \\\u003e **Preferences** \\\u003e **Plugins**.\n- Search for the 'Cloud Code' plugin and install it.\n\n You may be prompted to restart your IDE to activate the plugin.\n\nConfigure IntelliJ and your project\n-----------------------------------\n\nAfter installing the plugin, configure IntelliJ and your project to use the new\nplugin as follows:\n\n1. When notified that the new plugin conflicts with the existing\n App Engine integration, click the link in the prompt.\n\n2. In the following Disable Plugin prompt, select 'Disable and Restart' to\n disable the App Engine plugin and restart the IDE for the plugin\n configuration changes to take effect.\n\n3. When notified that your project is in an old format, click the option to\n **Convert** your project to the new format.\n\n4. You should delete your existing App Engine Server and Cloud\n instances and recreate them using the new gcloud CLI.\n\n 1. Navigate to **Settings** \\\u003e **Build, Execution, Deployment** \\\u003e\n **Application Servers**.\n\n 2. Select your **App Engine Dev** instances and click\n **Delete** (-).\n\n 3. Click **Add** (+) and select **Google App Engine Dev Server**.\n\n 4. Navigate to **Settings** \\\u003e **Build, Execution, Deployment** \\\u003e\n **Clouds**.\n\n 5. Select your **Google App Engine** cloud instances and click\n **Delete** (-).\n\n 6. Click **Add** (+) to configure an App Engine cloud deployment\n target.\n\n5. If you have any App Engine local server run configurations, then\n you must update them to use the newly configured Application Server.\n\n6. Navigate to **Tools** \\\u003e **Cloud Code** \\\u003e **App Engine** to see the list of actions\n available to you for running and deploying your application, or view\n [the documentation](/code/docs/intellij/how-to) for more information.\n\n7. For Maven or Gradle-based projects, ensure that you are using the latest\n version of the Gradle and Maven App Engine plugins.\n\nConfiguring IntelliJ-specific projects\n--------------------------------------\n\nFor IntelliJ-specific projects only (i.e., projects that have manually configured\nproject settings with the old App Engine facet and are not synced from\nGradle or Maven), update your App Engine dependencies.\n\nYour App Engine dependencies are still configured as\n'External Libraries' and provided by your old App Engine SDK\ninstallation. If you delete your App EngineSDK installation, your\napplication will not compile.\n\nTo remove this dependency on the old App Engine SDK, configure your\nApp Engine API dependencies using the App Engine Facet\nlibrary import feature as follows:\n\n1. Users of the old plugin's Datanucleus JDO/JPA enhancement feature need to\n port their applications to Maven or Gradle as Datanucleus enhancement is not\n supported by the Cloud Code plugin.\n\n2. From the IntelliJ Project Structure UI, navigate to your App Engine\n Standard module's dependencies tab.\n\n3. Remove all App Engine related libraries.\n\n4. In the same Project Structure UI, navigate to your App Engine\n module's **Google App Engine** facet.\n\n5. In the **Libraries** panel, select the App Engine dependencies you\n are using.\n\n This action will automatically retrieve these dependencies from Maven\n Central and add them to your module classpath.\n6. Run locally and deploy to verify your new configuration is working.\n\n7. At this point, you can safely delete your old App Engine SDK.\n\nGet support\n-----------\n\nTo submit feedback or report an issue in your IntelliJ IDE, go to **Tools** \\\u003e **Cloud Code** \\\u003e **Help / About** \\\u003e **Submit\nfeedback or report an issue** to report an issue on [GitHub](https://github.com/GoogleCloudPlatform/cloud-code-intellij/issues)."]]