Installation

Installation Guide

NPM JSR BUN

AgentForce ADK is available on both NPM and JSR (JavaScript Registry), making it easy to install in any JavaScript/TypeScript project regardless of your runtime preference.

Project Setup Example

Here’s a complete example of setting up a new project with AgentForce ADK using Bun:

# Create a new project directory
mkdir my-agentforce-project
cd my-agentforce-project

# Initialize a new Bun project
bun init

# Install AgentForce ADK
bun add @agentforce/adk

# Create a test file to verify installation
touch test-installation.ts

Add the following content to test-installation.ts:

import { AgentForceAgent } from '@agentforce/adk';

const agent = new AgentForceAgent({ name: "TestAgent" });

console.log("✅ AgentForce ADK installed successfully!");
console.log("Agent created:", agent);

Run the test to verify everything is working:

bun run test-installation.ts

You should see output confirming that AgentForce ADK is installed and working correctly.

Other Installation Methods

Choose your preferred package manager and runtime:

bun add @agentforce/adk

npm install @agentforce/adk

npx jsr add @agentforce/adk

bunx jsr add @agentforce/adk

deno add jsr:@agentforce/adk

Installation Methods Comparison

Method	Best For	Benefits	Compatibility
npm	Node.js projects, existing npm workflows	Largest ecosystem, familiar tooling	Node.js, Bun
JSR	TypeScript-first projects, cross-runtime compatibility	Native TypeScript, better type checking	Node.js, Bun, Deno
Bun (npm)	Fast development, modern JavaScript projects	Fastest package manager, built-in TypeScript	Bun, Node.js

Runtime Compatibility

Bun

Recommended Version: 1.0.0+

# Using Bun (from npm)
bun add @agentforce/adk

# Using JSR
bunx jsr add @agentforce/adk

Deno

Recommended Version: 1.40.0+

# Using JSR (recommended)
deno add jsr:@agentforce/adk

Node.js

Recommended Versions: 18.x, 20.x, 22.x+

# Using npm with tsc
npm install @agentforce/adk

# Using JSR using .js extension
npx jsr add @agentforce/adk

Browsers

Build Tools: Vite, Webpack, Rollup

Works with bundlers using any installation method above.

Verify Installation

After installation, verify that AgentForce ADK is working correctly:

import { AgentForceAgent } from '@agentforce/adk';

const agent = new AgentForceAgent({ name: "TestAgent" });

console.log("✅ AgentForce ADK installed successfully!");
console.log("Agent created:", agent);

import { AgentForceAgent } from "jsr:@agentforce/adk";

const agent = new AgentForceAgent({
  name: "TestAgent"
});

console.log("✅ AgentForce ADK installed successfully!");
console.log("Agent created:", agent);

import { AgentForceAgent } from '@agentforce/adk';

const agent = new AgentForceAgent({ name: "TestAgent" });

console.log("✅ AgentForce ADK installed successfully!");
console.log("Agent created:", agent);

Run the test:

bun run test-installation.ts

deno run test-installation.ts

node test-installation.js
# or for TypeScript
npx tsx test-installation.ts

TypeScript Configuration

For the best TypeScript experience, ensure your tsconfig.json includes:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    "strict": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  }
}

Troubleshooting

Common Installation Issues

Module not found errors:

Ensure you’re using the correct import syntax for your runtime
For Node.js with CommonJS, use require()
For ES modules, use import

TypeScript errors:

Update to TypeScript 4.5+ for best compatibility
Ensure moduleResolution is set to "bundler" or "node"

Deno permissions:

Deno may require network permissions for some operations:
Terminal window
```
deno run --allow-net your-script.ts
```

Version conflicts:

Use exact versions in package.json to avoid conflicts
Clear cache: npm cache clean --force or bun cache clean

Next Steps

Now that AgentForce ADK is installed, you’ll need to set up AI providers to power your agents:

Provider Setup - Configure Ollama (local) or OpenRouter (cloud)
Quick Start - Create your first agent
Basic Agents Guide - Learn agent fundamentals