Skip to Content

Installation

Stable

Set up your development environment for elizaOS Cloud integration.

SDK Installation

Install the official elizaOS packages:

bash bun add @elizaos/core @elizaos/plugin-elizacloud

CLI Installation

Install the elizaOS CLI for deployment and management:

bun add -g @elizaos/cli

Verify the installation:

elizaos --version

Requirements

RequirementVersion
Node.js18.0+
BunLatest
TypeScript5.0+ (recommended)

Project Setup

Initialize a New Project

elizaos init my-agent
cd my-agent

Install Dependencies

bun install

Configure Environment

Create a .env file:

# elizaOS Cloud Configuration
ELIZA_API_KEY=your_api_key_here
ELIZA_API_URL=https://cloud.milady.ai/api/v1
 
# Optional: Model Provider Keys (if using direct providers)
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...

Start Development

bun run dev

TypeScript Configuration

For TypeScript projects, ensure your tsconfig.json includes:

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

Package Versions

Install the latest stable versions:

bun add @elizaos/core@latest @elizaos/plugin-elizacloud@latest

Always use matching versions of elizaOS packages to avoid compatibility issues. Run bun update regularly to get the latest fixes.

Next Steps