ADK-TSInstallation
Install ADK TypeScript and set up your development environment
Prerequisites
System Requirements
- Node.js: v22.0 or higher
- Package Manager: npm, yarn, or pnpm
- TypeScript: v5.3 or higher (optional but recommended)
Recommended: CLI Installation
The fastest way to get started is using our CLI tool:
npx @iqai/adk-cli newOr install globally:
npm install -g @iqai/adk-cli
adk newThis creates a complete project with examples, TypeScript configuration, and all dependencies.
Ready to Build?
After installation, head to the Quickstart Guide to create your first agent and learn the fundamentals.
Add to Existing Project
To add ADK to an existing TypeScript project:
npm install @iqai/adkyarn add @iqai/adkpnpm add @iqai/adkComplete Setup Guide
For step-by-step project setup instructions, environment configuration, and your first agent, see the Quickstart Guide.
Quick Test
Verify the installation works:
import { AgentBuilder } from "@iqai/adk";
const response = await AgentBuilder
.withModel("gemini-2.5-flash")
.ask("Hello! Installation working?");
console.log("✅ Response:", response);Troubleshooting
Common Installation Issues
Node.js Version
If you encounter installation errors, ensure you're using Node.js v22.0 or higher:
node --versionTypeScript Compatibility
For TypeScript projects, ensure you're using v5.3 or higher:
npx tsc --versionGetting Help
If you encounter issues:
- Check the examples: Our examples directory contains working setups
- Review error messages: Most installation issues are dependency-related
- Open an issue: Report bugs or compatibility issues on GitHub
Next Steps
Now that ADK is installed:
- Build your first agent - Complete project setup and create your first agent
- Explore examples - See real working implementations
- Learn core concepts - Understand agents, tools, and workflows
Start Here
Head to the Quickstart Guide for your complete setup walkthrough and first agent!
How is this guide?