ContextQMD
Back to Tuist

Install Gradle Plugin

server/priv/docs/en/guides/install-gradle-plugin.md

4.191.83.6 KB
Original Source

Install the Gradle plugin {#install-the-gradle-plugin}

Tuist provides a Gradle plugin that integrates with your Gradle project to enable features like <.localized_link href="/guides/features/cache/gradle-cache">remote build caching</.localized_link> and <.localized_link href="/guides/features/build-insights/gradle">build insights</.localized_link>. This guide walks you through installing and configuring the plugin.

[!WARNING] Requirements

  • <.localized_link href="/guides/install-tuist">Tuist CLI</.localized_link> 4.138.1 or later
  • A Gradle project

1. Initialize Tuist {#initialize-tuist}

Run the following command in your Gradle project root:

::: code-group

bash
mise x tuist@latest -- tuist init
bash
tuist init
<!-- -->

:::

The command will walk you through authenticating, creating or selecting a Tuist project, and generating the configuration for your Gradle project.

2. Apply the plugin {#apply-the-plugin}

After running tuist init, you'll need to add the Tuist plugin to your settings.gradle.kts as instructed by the command output:

kotlin
plugins {
    id("dev.tuist") version "0.1.0"
}

3. Authenticate your team and CI {#authenticate}

While tuist init authenticates you locally, your teammates and CI environments will need to authenticate separately.

Each teammate should run the following to get access to the Tuist features on their machine:

bash
tuist auth login

For CI, follow the <.localized_link href="/guides/integrations/continuous-integration#authentication">CI authentication guide</.localized_link> to configure authentication for your environment.

Configuration reference {#configuration-reference}

The following options are available in the tuist extension block in settings.gradle.kts:

OptionTypeDefaultDescription
projectString?null (optional)The project identifier in account/project format. If not set, the plugin reads it from tuist.toml.
executablePathString?null (uses tuist from PATH)Path to the Tuist CLI executable.
urlString?nullThe base URL of the Tuist server. If not set, it defaults to "https://tuist.dev" or the value defined in tuist.toml.
uploadInBackgroundBoolean?nullWhether to upload build and test insights in the background. When null (default), uploads run in the background for local builds and in the foreground on CI.

[!NOTE] Tuist.toml

The recommended way to configure project (and optionally url) is through a tuist.toml file in your project root. This way the configuration is shared between the Tuist CLI and the Gradle plugin. You can still override these values in settings.gradle.kts if needed.

HTTP proxy {#http-proxy}

If your network routes outbound traffic through an HTTP proxy, see the <.localized_link href="/guides/integrations/http-proxy">HTTP proxy guide</.localized_link>.

Next steps {#next-steps}

Once the plugin is installed and configured, you can enable:

  • <.localized_link href="/guides/features/cache/gradle-cache">Remote build cache</.localized_link> to share build artifacts across your team and CI.
  • <.localized_link href="/guides/features/build-insights/gradle">Build insights</.localized_link> to track task timings and cache behavior in the Tuist dashboard.
  • <.localized_link href="/guides/features/test-insights/gradle">Test insights</.localized_link> to track test performance and detect flaky tests.
  • <.localized_link href="/guides/features/test-insights/flaky-tests">Flaky tests</.localized_link> to automatically detect, track, and quarantine flaky tests.