Advanced setup ↗
noOriginal Documentation
Create & activate virtual environment#
We recommend creating a virtual Python environment using venv:
python -m venv .venvNow, you can activate the virtual environment using the appropriate command for your operating system and environment:
# Mac / Linux
source .venv/bin/activate
# Windows CMD:
.venv\Scripts\activate.bat
# Windows PowerShell:
.venv\Scripts\Activate.ps1Install ADK#
pip install google-adk(Optional) Verify your installation:
pip show google-adkInstall ADK and ADK DevTools#
npm install @google/adk @google/adk-devtoolsCreate a new Go module#
If you are starting a new project, you can create a new Go module:
go mod init example.com/my-agentInstall ADK#
To add the ADK to your project, run the following command:
go get google.golang.org/adkThis will add the ADK as a dependency to your go.mod file.
(Optional) Verify your installation by checking your go.mod file for the google.golang.org/adk entry.
You can either use maven or gradle to add the google-adk and google-adk-dev package.
google-adk is the core Java ADK library. Java ADK also comes with a pluggable example SpringBoot server to run your agents seamlessly. This optional package is present as part of google-adk-dev.
If you are using maven, add the following to your pom.xml:
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example.agent</groupId>
<artifactId>adk-agents</artifactId>
<version>1.0-SNAPSHOT</version>
<!-- Specify the version of Java you'll be using -->
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<!-- The ADK core dependency -->
<dependency>
<groupId>com.google.adk</groupId>
<artifactId>google-adk</artifactId>
<version>1.0.0</version>
</dependency>
<!-- The ADK dev web UI to debug your agent -->
<dependency>
<groupId>com.google.adk</groupId>
<artifactId>google-adk-dev</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies>
</project>Here’s a complete pom.xml file for reference.
If you are using gradle, add the dependency to your build.gradle:
build.gradle
dependencies {
implementation 'com.google.adk:google-adk:1.0.0'
implementation 'com.google.adk:google-adk-dev:1.0.0'
}You should also configure Gradle to pass -parameters to javac. (Alternatively, use @Schema(name = "...")).
Next steps#
- Try creating your first agent with the Get started guides.