Skip to main content

Installation

Get started with the SMRT Agent Framework in seconds. One command installs everything you need to build powerful AI agents.

Prerequisites​

Before installing SMRT, ensure you have:

  • Bun 1.0+ installed (our recommended JavaScript runtime)
  • TypeScript 5.0+ for type safety
  • An API key from at least one AI provider (OpenAI, Anthropic, etc.)

Quick Install​

SMRT is designed to be installed with a single command:

bun add @have/smrt
info

While other package managers work, we strongly recommend Bun for the best performance and compatibility with the HAVE SDK ecosystem.

What Gets Installed?​

When you install @have/smrt, you automatically get:

  • Core Framework: Agent, SmartObject, Collection classes
  • Database Integration: SQLite for development, PostgreSQL support for production
  • AI Client: Unified interface for multiple AI providers
  • Code Generators: CLI, REST API, and MCP server generators
  • Type Definitions: Full TypeScript support out of the box

Environment Setup​

Create a .env file in your project root to configure AI providers:

# OpenAI (most common)
OPENAI_API_KEY=sk-...

# Anthropic (Claude)
ANTHROPIC_API_KEY=sk-ant-...

# Google (Gemini)
GOOGLE_AI_API_KEY=...

# AWS Bedrock
AWS_ACCESS_KEY_ID=...
AWS_SECRET_ACCESS_KEY=...
AWS_REGION=us-east-1

# Database (optional, defaults to SQLite)
DATABASE_URL=postgres://user:pass@localhost/dbname

💡 Tip: Start with just an OpenAI API key. You can add other providers later as needed.

TypeScript Configuration​

SMRT works best with these TypeScript settings. Add to your tsconfig.json:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "lib": ["ES2022"],
    "esModuleInterop": true,
    "skipLibCheck": true,
    "strict": true,
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "resolveJsonModule": true,
    "allowSyntheticDefaultImports": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

Verify Installation​

Create a simple test file to verify everything is working:

// test-smrt.ts
import { Agent, SmartObject } from '@have/smrt';
import { getAIClient } from '@have/ai';

async function testInstallation() {
  console.log('✅ SMRT imported successfully');
  
  // Test AI client
  const ai = await getAIClient({ provider: 'openai' });
  console.log('✅ AI client created');
  
  // Test SmartObject
  class TestObject extends SmartObject {
    name: string = 'Test';
  }
  console.log('✅ SmartObject defined');
  
  // Test Agent
  const agent = new Agent({
    ai,
    name: 'TestAgent'
  });
  console.log('✅ Agent created');
  
  console.log('\n🎉 SMRT is ready to use!');
}

testInstallation().catch(console.error);

Run the test:

bun run test-smrt.ts
# or
ts-node test-smrt.ts

Project Structure​

Here's the recommended structure for a SMRT project:

my-agent-project/
├── src/
│   ├── agents/           # Your agent definitions
│   │   └── research-agent.ts
│   ├── objects/          # SmartObject models
│   │   ├── document.ts
│   │   └── task.ts
│   ├── tools/            # Custom tools for agents
│   │   └── web-search.ts
│   └── index.ts          # Main entry point
├── .env                  # Environment variables
├── tsconfig.json         # TypeScript config
└── package.json          # Project dependencies

Installing Additional Capabilities​

As your agents need more capabilities, install additional HAVE SDK packages:

File System Operations​

bun add @have/files

PDF Processing​

bun add @have/pdf

Web Scraping​

bun add @have/spider

Advanced Database Features​

bun add @have/sql

🎯 Pro Tip: Start with just @have/smrt. Add other packages only when you need specific capabilities. SMRT includes the essentials to get started.

Platform-Specific Notes​

macOS​

  • Install Bun: curl -fsSL https://bun.sh/install | bash
  • Native SQLite support included with Bun

Windows​

  • Use WSL2 for best compatibility with Bun
  • Install Bun in WSL2: curl -fsSL https://bun.sh/install | bash

Linux​

  • Install Bun: curl -fsSL https://bun.sh/install | bash
  • Install build-essential for native module compilation: 
    sudo apt-get install build-essential

Docker​

  • Use Bun in your Docker images for optimal performance: 
    FROM oven/bun:latest
    RUN bun add -g @have/smrt

Troubleshooting​

Common Issues​

Issue: "Cannot find module '@have/smrt'"

  • Solution: Ensure you're in the correct directory and packages are installed

Issue: "API key not found"

  • Solution: Check your .env file and ensure environment variables are loaded

Issue: "Database connection failed"

  • Solution: SMRT defaults to SQLite. Ensure write permissions in your project directory

Issue: "TypeScript errors"

  • Solution: Update your tsconfig.json with the recommended settings above

Next Steps​

Now that SMRT is installed, you're ready to build your first agent!

Build Your First Agent →

Explore the Framework →

Need Help? Join our Discord community for support and discussions.