---
title: Installation
description: Install the elizaOS SDK and scaffolding CLI for local development.
---

# Installation

Set up your development environment for elizaOS Cloud integration.

## SDK Installation

Install the official elizaOS packages:

<Tabs>
  <Tab title="bun">

```bash
bun add @elizaos/core @elizaos/plugin-elizacloud
```
  </Tab>
</Tabs>

## CLI Installation

Install the elizaOS CLI for project and plugin scaffolding:

```bash
bun add -g elizaos@beta
```

Verify the installation:

```bash
elizaos --version
```

## Requirements

| Requirement | Version            |
| ----------- | ------------------ |
| Node.js     | 24.0+              |
| Bun         | Latest             |
| TypeScript  | 5.0+ (recommended) |

## Project Setup

<Steps>
<Step title="Initialize a New Project">

```bash
elizaos create my-agent --template project
cd my-agent
```

</Step>

<Step title="Install Dependencies">

```bash
bun install
```

</Step>

<Step title="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-...
```

</Step>

<Step title="Start Development">

```bash
bun run dev
```

</Step>
</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
```

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

## Next Steps

- [Authentication](/cloud/authentication) - Set up API authentication
- [Quickstart](/cloud/quickstart) - Build your first agent