Installation

This guide covers installing Regent SDK packages and setting up your development environment.

Prerequisites

• Bun >= 1.0 (recommended) or Node.js >= 20.9

• An API key from your preferred LLM provider (OpenAI, Anthropic, etc.) if building AI-powered agents

• Optional: A wallet address for receiving payments

Using the CLI (Recommended)

The fastest way to get started is with the CLI, which scaffolds a complete project:

# Interactive mode - CLI guides you through options
bunx @regent/cli my-agent

The CLI prompts you to select:

• Adapter: hono, tanstack-ui, tanstack-headless, express, or next

• Template: blank, axllm, axllm-flow, identity, trading-data-agent, or trading-recommendation-agent

• Configuration: Agent metadata, LLM keys, and optional payment details

Non-Interactive Mode

For CI/CD or scripted setups:

bunx @regent/cli my-agent \
  --adapter=hono \
  --template=axllm \
  --non-interactive \
  --AGENT_NAME="My AI Agent" \
  --AGENT_DESCRIPTION="AI-powered assistant" \
  --OPENAI_API_KEY=your_api_key_here \
  --PAYMENTS_RECEIVABLE_ADDRESS=0xYourAddress \
  --network=base-sepolia

Using the Unified Package

For most projects, install the unified regent-sdk package:

bun add regent-sdk

This includes all core functionality:

import {
  createRegentAgent,
  createRegentSDK,
  createAgent,
  http,
  a2a,
  RegentErc8004SDK,
} from 'regent-sdk';

Manual Installation

For fine-grained control, install individual packages:

Core Packages

# Core runtime (required)
bun add @regent/core @regent/types

# HTTP extension (required for web servers)
bun add @regent/http

Framework Adapter

Install the adapter for your framework:

# Hono (lightweight, edge-compatible)
bun add @regent/hono hono

# TanStack Start (full-stack React)
bun add @regent/tanstack @tanstack/start

# Express (traditional Node.js)
bun add @regent/express express

Next.js (App Router) is supported via scaffolding (bunx @regent/cli --adapter=next) rather than a standalone @regent/next package.

Optional Extensions

# Payments (x402 protocol)
bun add @regent/x402

# On-chain identity (ERC-8004)
bun add @regent/erc8004

# Agent-to-Agent communication
bun add @regent/a2a

# Wallet management
bun add @regent/wallet

# Agent Payments Protocol
bun add @regent/ap2

# Scheduler for recurring tasks
bun add @regent/scheduler

# Payment analytics
bun add @regent/analytics

Peer Dependencies

Some extensions have peer dependencies:

# For x402 payments
bun add x402 x402-fetch

# For erc8004 and wallet operations
bun add viem

# For schema validation (likely already installed)
bun add zod

Package Overview

Package	Purpose
regent-sdk	Unified SDK with high-level APIs
@regent/core	Protocol-agnostic agent runtime with extension system
@regent/types	Shared TypeScript type definitions
@regent/http	HTTP extension for request/response handling and SSE
@regent/hono	Hono framework adapter
@regent/tanstack	TanStack Start adapter (UI and headless)
@regent/express	Express framework adapter
@regent/x402	x402 payment protocol and policies
@regent/erc8004	ERC-8004 identity, discovery, and reputation
@regent/a2a	A2A protocol client
@regent/wallet	Wallet connectors and helpers
@regent/ap2	Agent Payments Protocol extension
@regent/scheduler	Scheduled agent invocations
@regent/analytics	Payment tracking and reporting
@regent/cli	CLI scaffolding tool (source: monorepo/regent-cli/)

Environment Variables

Create a .env file in your project root:

# Agent metadata
AGENT_NAME="My Agent"
AGENT_DESCRIPTION="Description of what the agent does"

# LLM provider (if using axllm template)
OPENAI_API_KEY=sk-...
# Or for other providers:
# ANTHROPIC_API_KEY=...

# Payments (optional)
#
# If you use @regent/cli scaffolding, you’ll typically set:
PAYMENTS_FACILITATOR_URL=https://facilitator.regent.cx
PAYMENTS_NETWORK=base-sepolia
PAYMENTS_RECEIVABLE_ADDRESS=0x...
#
# If you use @regent/x402 paymentsFromEnv(), it reads:
# FACILITATOR_URL, NETWORK, PAYMENTS_RECEIVABLE_ADDRESS

# Wallet (optional)
AGENT_WALLET_TYPE=local
AGENT_WALLET_PRIVATE_KEY=0x...
AGENT_WALLET_CHAIN_ID=84532

# ERC-8004 Identity (optional)
RPC_URL=https://sepolia.base.org
PINATA_JWT=...  # For IPFS metadata storage

Verify Installation

After installation, verify everything works:

cd my-agent
bun run dev

Your agent should be running at http://localhost:3000. Test it:

# View agent manifest
curl http://localhost:3000/.well-known/agent.json

# List entrypoints
curl http://localhost:3000/entrypoints

Next Steps

• Quickstart - Build your first agent

• Concepts: Agents - Understand agent configuration