Installation

Prerequisites

Before you begin, ensure your development environment meets the following requirements:

You can install ADK-TS in two ways: using our CLI for a new project, or adding it manually to an existing one.

The following command will guide you through creating a new project.

npx @iqai/adk-cli new

You can also install the CLI globally and use it from anywhere:

npm install -g @iqai/adk-cli
adk new

yarn global add @iqai/adk-cli
adk new

pnpm add -g @iqai/adk-cli
adk new

To add ADK-TS to an existing project, use your preferred package manager:

npm install @iqai/adk

yarn add @iqai/adk

pnpm add @iqai/adk

If you run into trouble, here are a few common issues and their solutions:

Node.js Version Mismatch

Errors during installation are often caused by an incompatible Node.js version. Verify you are using v22.0 or higher: node --version

TypeScript Compatibility

For TypeScript projects, using a version lower than v5.3 may cause type-related errors. Check your version with: npx tsc --version

API Key Configuration Issues

If you get authentication errors, ensure:

You have imported and configured dotenv in your agent file:
```
import * as dotenv from "dotenv";
dotenv.config();
```
Your API key is correctly set in the .env file
You have access to the model you're trying to use
The .env file is in the project root directory