Installation

Prerequisites

System Requirements

Node.js: v22.0 or higher
Package Manager: npm, yarn, or pnpm
TypeScript: v5.3 or higher (optional but recommended)

Quick Install

Install the Package

npm install @iqai/adk

yarn add @iqai/adk

pnpm add @iqai/adk

Set Up Environment Variables

Create a .env file in your project root:

# Optional: specify your preferred LLM model
LLM_MODEL=gemini-2.5-flash

# Add any API keys if needed for specific tools
# GOOGLE_API_KEY=your_google_api_key_here

Verify Installation

Create a simple test file to verify everything is working:

import { AgentBuilder } from "@iqai/adk";

async function test() {
  try {
    const response = await AgentBuilder
      .withModel("gemini-2.5-flash")
      .ask("Hello! Can you confirm the installation is working?");

    console.log("✅ Installation successful!");
    console.log("Response:", response);
  } catch (error) {
    console.error("❌ Installation issue:", error);
  }
}

test();

Run the Test

npx tsx test-install.ts

npx ts-node test-install.ts

npx tsc test-install.ts
node test-install.js

Project Setup

For a new TypeScript project, you can set up a complete environment:

Initialize Project

mkdir my-adk-project
cd my-adk-project
npm init -y

Install Dependencies

# Core dependencies
npm install @iqai/adk

# Development dependencies
npm install -D typescript tsx @types/node

# Optional utilities (used in examples)
npm install dedent uuid dotenv
npm install -D @types/uuid

Configure TypeScript

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "declaration": true,
    "outDir": "./dist"
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}