ContextQMD
Back to Eliza

Installation

packages/cloud-frontend/content/installation.mdx

2.0.12.0 KB
Original Source

import { Tabs, Callout, Steps } from "@/docs/components";

Installation

<div className="status-badge status-stable">Stable</div>

Set up your development environment for elizaOS Cloud integration.

SDK Installation

Install the official elizaOS packages:

<Tabs items={["bun"]}> <Tabs.Tab>

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

</Tabs.Tab> </Tabs>

CLI Installation

Install the elizaOS CLI for project and plugin scaffolding:

bash
bun add -g elizaos

Verify the installation:

bash
elizaos --version

Requirements

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

Project Setup

<Steps> ### Initialize a New Project
bash
elizaos create my-agent --template project
cd my-agent

Install Dependencies

bash
bun install

Configure Environment

Create a .env file:

bash
# elizaOS Cloud Configuration
ELIZA_API_KEY=your_api_key_here
ELIZA_API_URL=https://elizacloud.ai/api/v1

# Optional: Model Provider Keys (if using direct providers)
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...

Start Development

bash
bun run dev
</Steps>

TypeScript Configuration

For TypeScript projects, ensure your tsconfig.json includes:

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

Package Versions

Install the latest stable versions:

bash
bun add @elizaos/core@latest @elizaos/plugin-elizacloud@latest
<Callout type="warning"> Always use matching versions of elizaOS packages to avoid compatibility issues. Run `bun update` regularly to get the latest fixes. </Callout>

Next Steps