### Quick Start Installation and Run (Bash)

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/a2a/README.md

Commands to install dependencies and start the A2A server example.

```bash
cd examples/a2a
bun install
bun run start
```

--------------------------------

### Install Dependencies and Start Dev Server

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/react/README.md

Follow these commands to install dependencies and start the development server for the React example.

```bash
bun install

cd examples/react

bun dev
```

--------------------------------

### Install and Run Next.js Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples-gallery/web-apps.mdx

Navigate to the Next.js example directory, install dependencies, and start the development server. Ensure your OpenAI API key is set as an environment variable.

```bash
cd examples/next
bun install
OPENAI_API_KEY="your-key" bun dev
```

--------------------------------

### Install and Run Express Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples/rest-api.mdx

Use this command to install dependencies and start the Express REST API server.

```bash
cd examples/rest-api/express
bun install
bun run start
```

--------------------------------

### Quick Start: Install Dependencies and Run

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/rest-api/README.md

Installs project dependencies and starts the server. Ensure you set the OPENAI_API_KEY environment variable.

```bash
cd express  # or hono, elysia
bun install
OPENAI_API_KEY=your-key bun run start
```

--------------------------------

### Install and Run Hono Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples/rest-api.mdx

Use this command to install dependencies and start the Hono REST API server.

```bash
cd examples/rest-api/hono
bun install
bun run start
```

--------------------------------

### Install and Run FastAPI Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples/rest-api.mdx

Use these commands to set up a Python virtual environment, install dependencies, and start the FastAPI REST API server.

```bash
cd examples/rest-api/fastapi
python -m venv venv && source
virtualenv/bin/activate
pip install -r requirements.txt
python server.py
```

--------------------------------

### Project Setup

Source: https://github.com/elizaos/eliza/blob/develop/cloud/apps/frontend/public/llms-full.txt

Steps to initialize a new elizaOS project, install dependencies, configure environment variables, and start development.

```APIDOC
## Project Setup

### Initialize a New Project
```bash
elizaos init my-agent
cd my-agent
```

### Install Dependencies
```bash
bun install
```

### Configure Environment
Create a `.env` file with your API keys and URL:

```dotenv
ELIZA_API_KEY=your_api_key_here
ELIZA_API_URL=https://elizacloud.ai/api/v1

# Optional: Model Provider Keys
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...
```

### Start Development
```bash
bun run dev
```
```

--------------------------------

### Install and Run Auto Trader Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/trader/README.md

Navigate to the 'typescript' directory, install dependencies using 'bun install', and start the development server with 'bun dev'. Access the application at http://localhost:5173.

```bash
cd typescript
bun install
bun dev
```

--------------------------------

### Install Dependencies

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/lp-manager/README.md

Navigate to the LP Manager example directory and install the necessary dependencies using bun.

```bash
cd examples/lp-manager
bun install
```

--------------------------------

### Install and Run React Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples/browser.mdx

Instructions for setting up and running the React example. Requires Node.js and bun. Visit http://localhost:5173 after running.

```bash
cd examples/react
bun install
bun dev
# Visit http://localhost:5173
```

--------------------------------

### Install and Run Next.js Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples/browser.mdx

Instructions for setting up and running the Next.js example. Requires Node.js and bun. An OpenAI API key is needed for this example. Visit http://localhost:3000 after running.

```bash
cd examples/next
bun install
OPENAI_API_KEY="your-key" bun dev
# Visit http://localhost:3000
```

--------------------------------

### Install and Start Server

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/rest-api/express/README.md

Install dependencies using bun and start the Express.js server. The server defaults to http://localhost:3000.

```bash
bun install
bun run start
```

--------------------------------

### Start Local Development Server with Bun

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/vercel/README.md

Navigate to the Vercel examples directory, install dependencies using Bun, and start the local development server with `vercel dev`. The server will be accessible at `http://localhost:3000`.

```bash
cd examples/vercel
bun install
vercel dev
```

--------------------------------

### Start ElizaOS Backend Server

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/app/capacitor/README.md

Navigate to the backend directory, install its dependencies, and start the development server.

```bash
cd examples/app/capacitor/backend
bun install
bun run dev

```

--------------------------------

### Quick Start Express API

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples-gallery/rest-apis.mdx

Installs dependencies, starts the Express API, and sends a test message.

```bash
cd examples/rest-api/express
bun install && bun run start
curl -X POST http://localhost:3000/chat \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello!"}'
```

--------------------------------

### Start Frontend Development Server

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/app/capacitor/README.md

Navigate to the frontend directory, install its dependencies, and start the development server. The UI will be available at http://localhost:5176.

```bash
cd examples/app/capacitor/frontend
bun install
bun run dev

```

--------------------------------

### Basic CLI Commands

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/cli/overview.mdx

Examples of common global flag usage. Use '--version' to check the installed version, '--debug' to enable verbose logging for the 'start' command, and '--help' for command-specific assistance.

```bash
eliza --version
```

```bash
eliza --debug start
```

```bash
eliza plugins --help
```

--------------------------------

### Quick Start Hono API

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples-gallery/rest-apis.mdx

Installs dependencies, starts the Hono API, and sends a test message.

```bash
cd examples/rest-api/hono
bun install && bun run start
curl -X POST http://localhost:3000/chat \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello!"}'
```

--------------------------------

### Run Chat Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples-gallery/index.mdx

Navigate to the chat example directory and run the application using Bun. This is a simple way to start with elizaOS.

```bash
cd examples/chat && bun run start
```

--------------------------------

### Install and Run Elizagotchi

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/elizagotchi/README.md

Instructions for installing dependencies and starting the Elizagotchi development server.

```bash
# From the monorepo root
cd examples/elizagotchi

# Install dependencies
bun install

# Start the dev server
bun run dev
```

--------------------------------

### Quick Start Elysia API

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples-gallery/rest-apis.mdx

Installs dependencies, starts the Elysia API, and sends a test message.

```bash
cd examples/rest-api/elysia
bun install && bun run start
curl -X POST http://localhost:3000/chat \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello!"}'
```

--------------------------------

### Run CLI Chat Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples/overview.mdx

Demonstrates how to clone the repository, install dependencies, set the OpenAI API key, and run the CLI chat example.

```bash
git clone https://github.com/elizaos/eliza.git
cd eliza

bun install
export OPENAI_API_KEY="your-api-key-here"

# CLI chat
bun run examples/chat/chat.ts
```

--------------------------------

### Gauntlet Quick Start Commands

Source: https://github.com/elizaos/eliza/blob/develop/packages/benchmarks/gauntlet/README.md

Provides commands to clone the repository, install the benchmark, and run tests against different agents. Requires Python and pip for installation.

```bash
# Clone the repository
git clone https://github.com/light-research/gauntlet
cd solana-gauntlet

# Install
pip install -e .

# Run benchmark against the smart agent
gauntlet run --agent agents/smart_agent.py --mock

# Run with LLM agent (requires OPENAI_API_KEY)
export OPENAI_API_KEY="your-key"
gauntlet run --agent agents/llm_agent.py --mock

# List all scenarios
gauntlet list
```

--------------------------------

### Run Autonomous Example (Python)

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/autonomous/README.md

Navigate to the Python autonomous example directory, set up a virtual environment, install requirements, and run the Python script.

```bash
cd examples/autonomous/python
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python autonomous.py
```

--------------------------------

### Install and Run ElizaOS Project

Source: https://github.com/elizaos/eliza/blob/develop/README.md

Install dependencies and start the development server for an ElizaOS project. Ensure your OpenAI API key is set in the .env file.

```bash
OPENAI_API_KEY=...
bun install
bun run dev
```

--------------------------------

### Install Dependencies and Run MCP Server

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/mcp/README.md

Installs project dependencies using bun and starts the MCP server. Requires an OpenAI API key to be set.

```bash
cd examples/mcp
bun install
OPENAI_API_KEY=your-key bun run start
```

--------------------------------

### Quickstart: Download and Prepare Datasets

Source: https://github.com/elizaos/eliza/blob/develop/packages/training/README.md

A sequence of commands to set up the training environment, download datasets, extract prompts, normalize data, and pack the dataset for training.

```bash
cd training
uv sync --extra train
uv run python scripts/download_datasets.py
uv run python scripts/extract_eliza_prompts.py
uv run python scripts/normalize.py
uv run python scripts/synthesize_targets.py --task should_respond  # optional
uv run python scripts/pack_dataset.py
```

--------------------------------

### Local Testing Commands for AWS Examples

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/aws/README.md

Commands to install dependencies, run automated tests, and start a local HTTP server for the AWS Lambda examples.

```bash
cd examples/aws
bun install
bun run test                # Automated tests
bun run start               # Local HTTP server on port 3000
```

--------------------------------

### Start Eliza and Check Status

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/guides/config-templates.md

Commands to start Eliza, check model provider status, list installed plugins, and run built-in diagnostics to verify your setup.

```bash
# Start Eliza and check for startup errors
eliza

# Check model provider status
eliza models

# Check installed plugins
eliza plugins installed

# Run the built-in diagnostics
eliza doctor
```

--------------------------------

### Post-Creation Steps

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/cli-reference/create.mdx

After creating a new workspace, navigate into the directory, install dependencies, and start the development server.

```bash
cd my-agent-app
bun install
bun run dev
```

--------------------------------

### Set Up Environment Variables

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/quickstart.mdx

Copy the example environment file and add your API keys. Keep secrets in local `.env` files and out of version control.

```bash
cp .env.example .env
```

```bash
OPENAI_API_KEY=your-api-key
```

--------------------------------

### Setup elizaOS development environment

Source: https://github.com/elizaos/eliza/blob/develop/packages/app/README.md

Clone the repository, navigate to the directory, and install dependencies using bun.

```bash
git clone https://github.com/elizaOS/eliza.git
cd eliza

bun install
bun run build
```

--------------------------------

### Run Bluesky Agent - TypeScript

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/bluesky/README.md

Navigate to the TypeScript example directory, install its dependencies, and start the agent. This is the primary way to run the agent if you are developing in TypeScript.

```bash
cd examples/bluesky
bun install
bun run start
```

--------------------------------

### Vercel Edge Functions Deployment

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples/serverless.mdx

Commands to install dependencies, run locally, and deploy to Vercel. This example uses the 'edge' runtime for faster cold starts.

```bash
cd examples/vercel
bun install
vercel dev
vercel
```

--------------------------------

### Interact with Eliza CLI

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/guides/beginners-development-guide.md

Examples of using the Eliza command-line interface for common development tasks, such as getting help, starting the application verbosely, or retrieving configuration.

```bash
bun run eliza --help
bun run eliza start --verbose
bun run eliza config get agents.defaults.model
```

--------------------------------

### Start Development Environment

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/docs/superpowers/plans/2026-04-14-steward-wallet-cloud-login-wiring.md

Navigate to the project's root directory and start the development server. Ensure the API is ready before proceeding.

```bash
cd "$(git rev-parse --show-toplevel)"
bun run dev
```

--------------------------------

### Run the ElizaOS Twitter Agent

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/twitter-xai/README.md

After installing dependencies and building the workspace, navigate to the example directory and run the start script. Ensure your environment variables are correctly configured.

```bash
# from repo root (build workspace deps)
bun install
bun run build

cd packages/examples/twitter-xai
bun run start
```

--------------------------------

### Quick Start OSWorld Interaction

Source: https://github.com/elizaos/eliza/blob/develop/packages/benchmarks/OSWorld/README.md

Run a minimal example to interact with the OSWorld environment. This demonstrates basic usage with default settings and how to customize the provider and VM path.

```bash
# Basic usage with default settings
python quickstart.py

# Customize provider and VM path
python quickstart.py --provider_name vmware --path_to_vm "path/to/your/vm.vmx"
```

--------------------------------

### GET /api/ingest/share Response Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/rest/system.md

Example of the JSON response structure for the GET /api/ingest/share endpoint, showing items in the share ingest queue.

```json
{
  "items": [
    {
      "id": "uuid",
      "source": "chrome-extension",
      "title": "...",
      "receivedAt": 1718000000000
    }
  ]
}
```

--------------------------------

### Install and Start Hono Server

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/rest-api/hono/README.md

Install project dependencies and start the Hono REST API server. The server will be accessible at http://localhost:3000 by default.

```bash
bun install

bun run start
```

--------------------------------

### Install and Run Actix Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples/rest-api.mdx

Use this command to build and run the Actix Web REST API server.

```bash
cd examples/rest-api/actix
cargo run --release
```

--------------------------------

### Install and Run Game of Life Simulation

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples-gallery/games.mdx

Navigate to the game-of-life example directory, install dependencies, and run the simulation. This example demonstrates a multi-agent cellular simulation.

```bash
cd examples/game-of-life
bun install
bun run game.ts
```

--------------------------------

### SWE-bench CLI Example with Prebuilt Images

Source: https://github.com/elizaos/eliza/blob/develop/packages/benchmarks/swe_bench/RESEARCH.md

Example of running the SWE-bench CLI using prebuilt instance images from a specified namespace for faster evaluation. Includes instance ID, gold standard flag, namespace, and timeout.

```bash
python -m benchmarks.swe_bench.cli \
  --instance astropy__astropy-12907 \
  --gold \
  --swebench-namespace ghcr.io/epoch-research \
  --timeout 1800
```

--------------------------------

### Install Dependencies and Start Server

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/rest-api/elysia/README.md

Install project dependencies from the monorepo root and then start the Elysia REST API server. Ensure you are in the monorepo root directory before running these commands.

```bash
cd /path/to/eliza
bun install

bun run examples/rest-api/elysia/server.ts
```

--------------------------------

### Run CLI Chat Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples-gallery/chat-apps.mdx

Instructions to set up and run the CLI chat example. Ensure you have a provider API key configured in your .env file.

```bash
cd examples/chat
cp .env.example .env
# Add at least one provider API key to .env
bun install
bun run start
```

--------------------------------

### Install Plugin via npm

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/guides/registry.md

Install a plugin package using npm or bun. This example shows installing the Telegram connector.

```bash
# Install the Telegram connector
bun add @elizaos/plugin-telegram
```

--------------------------------

### Full ElizaOS Configuration Example

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/configuration.mdx

This example demonstrates a complete configuration file with common options for metadata, environment variables, logging, agent defaults and lists, gateway settings, connectors, tools, feature flags, and update channels.

```json5
{
  // Metadata
  meta: { lastTouchedVersion: "1.0.0" },

  // Environment variables
  env: {
    ANTHROPIC_API_KEY: "<ANTHROPIC_API_KEY>",
  },

  // Logging
  logging: { level: "info", consoleStyle: "pretty" },

  // Agent configuration
  agents: {
    defaults: {
      model: { primary: "anthropic/claude-sonnet-4.6" },
      workspace: "~/agent-workspace",
      thinkingDefault: "medium",
      sandbox: { mode: "non-main" },
    },
    list: [
      {
        id: "mila",
        default: true,
        name: "Mila",
        bio: ["A capable AI assistant"],
        system: "You are Mila.",
      },
    ],
  },

  // Gateway
  gateway: {
    port: 18789,
    bind: "loopback",
    auth: { mode: "token" },
  },

  // Connectors
  connectors: {
    telegram: { botToken: "<TELEGRAM_BOT_TOKEN>" },
  },

  // Tools
  tools: {
    exec: { security: "allowlist" },
    web: {
      search: { enabled: true, provider: "brave" },
    },
  },

  // Feature flags
  features: {
    browser: true,
    cron: true,
  },

  // Update channel
  update: { channel: "stable" },
}
```

--------------------------------

### Quickstart: Initialize tmux session and run Python REPL

Source: https://github.com/elizaos/eliza/blob/develop/packages/skills/skills/tmux/SKILL.md

Initializes a tmux session for a Python REPL and captures its initial output. Ensure the SOCKET_DIR is set or defaults to a temporary directory.

```bash
SOCKET_DIR="${OTTO_TMUX_SOCKET_DIR:-"${TMPDIR:-/tmp}/otto-tmux-sockets}"
mkdir -p "$SOCKET_DIR"
SOCKET="$SOCKET_DIR/otto.sock"
SESSION=otto-python

tmux -S "$SOCKET" new -d -s "$SESSION" -n shell
tmux -S "$SOCKET" send-keys -t "$SESSION":0.0 -- 'PYTHON_BASIC_REPL=1 python3 -q' Enter
tmux -S "$SOCKET" capture-pane -p -J -t "$SESSION":0.1 -S -200
```

--------------------------------

### Step-by-step Bootstrap Training from HuggingFace

Source: https://github.com/elizaos/eliza/blob/develop/packages/training/scripts/CLOUD_VAST.md

Performs a step-by-step setup for training, including provisioning, bootstrapping from HuggingFace for remote downloads and sync, and then running the full SFT.

```bash
bash scripts/train_vast.sh provision
```

```bash
bash scripts/train_vast.sh bootstrap-from-hf       # remote download + uv sync
```

```bash
bash scripts/train_vast.sh run                     # full SFT
```

--------------------------------

### Interactive Eliza Setup

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/cli/setup.mdx

Run the interactive wizard for a guided setup process. This is the default behavior when no flags are provided.

```bash
eliza setup
```

--------------------------------

### Quick Start: Deploy ElizaOS Project

Source: https://github.com/elizaos/eliza/blob/develop/cloud/README.md

This sequence of commands guides you through setting up your API key and deploying your ElizaOS project using the CLI. Ensure Docker is running.

```bash
# 1. Get your API key from the dashboard
# Visit https://your-domain.com/dashboard/api-keys

# 2. Set your API key
export ELIZAOS_API_KEY="eliza_your_api_key_here"

# 3. Ensure Docker is running locally
docker --version
docker info

# 4. Deploy your elizaOS project
cd your-elizaos-project
elizaos deploy
```

--------------------------------

### Run Autonomous Example (TypeScript)

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/autonomous/README.md

Navigate to the autonomous examples directory, install dependencies, and run the TypeScript autonomous loop.

```bash
cd examples/autonomous
bun install
bun run start
```

--------------------------------

### Install elizaOS globally via npm

Source: https://github.com/elizaos/eliza/blob/develop/packages/app/README.md

Install the elizaOS app globally using npm and then run the setup command.

```bash
npm install -g @elizaos/app
eliza setup
```

--------------------------------

### Start UI Development Server

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/farcaster-miniapp/README.md

Navigate to the miniapp directory and run this command to start the React/Vite development server for the UI.

```bash
cd examples/farcaster-miniapp
bun run dev
```

--------------------------------

### Evaluator with Training Examples

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/plugins/components.mdx

Defines an evaluator that uses training examples to guide its behavior, particularly for tasks like fact extraction. Ensure examples are representative of expected inputs and outcomes.

```typescript
const evaluator: Evaluator = {
  name: "fact-extractor",
  description: "Extracts facts from conversations",
  examples: [
    {
      prompt: "Extract facts from this conversation",
      messages: [
        { name: "user", content: { text: "I live in NYC" } },
        { name: "agent", content: { text: "NYC is a great city!" } },
      ],
      outcome: "User lives in New York City",
    },
  ],
  validate: async () => true,
  handler: async (runtime, message, state) => {
    const facts = await extractFacts(state);
    for (const fact of facts) {
      await runtime.factsManager.addFact(fact);
    }
    return facts;
  },
};
```

--------------------------------

### Example Onboarding Request

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/rest/onboarding.md

Demonstrates submitting an agent configuration for Eliza Cloud hosting with direct Anthropic inference. This includes specifying deployment target, linked accounts, credentials, and service routing.

```json
{
  "name": "Eliza",
  "bio": ["A helpful AI assistant"],
  "deploymentTarget": {
    "runtime": "cloud",
    "provider": "elizacloud"
  },
  "linkedAccounts": {
    "elizacloud": {
      "status": "linked",
      "source": "oauth"
    }
  },
  "credentialInputs": {
    "cloudApiKey": "ck_live_example",
    "llmApiKey": "sk-ant-example"
  },
  "serviceRouting": {
    "llmText": {
      "backend": "anthropic",
      "transport": "direct",
      "primaryModel": "anthropic/claude-sonnet-4.6"
    }
  }
}
```

--------------------------------

### Install and Run Mineflayer Bridge Server

Source: https://github.com/elizaos/eliza/blob/develop/plugins/plugin-minecraft/mineflayer-server/README.md

Install dependencies, configure environment variables for Minecraft connection, build, and start the server.

```bash
cd plugins/plugin-minecraft/mineflayer-server
bun install

export MC_SERVER_PORT=3457
export MC_HOST=127.0.0.1
export MC_PORT=25565
export MC_AUTH=offline
export MC_USERNAME=ElizaBot

bun run build
bun run start
```

--------------------------------

### Install Dependencies and Run Development Server

Source: https://github.com/elizaos/eliza/blob/develop/cloud/examples/clone-ur-crush/README.md

Commands to install project dependencies and start the development server for the Clone Your Crush application.

```bash
bun install
bun run dev
```

--------------------------------

### Notion API Key Setup

Source: https://github.com/elizaos/eliza/blob/develop/packages/skills/skills/notion/SKILL.md

Instructions for setting up the Notion API key by creating an integration, copying the key, and storing it in a configuration file.

```bash
mkdir -p ~/.config/notion
echo "ntn_your_key_here" > ~/.config/notion/api_key
```

--------------------------------

### Run elizaOS setup without global installation

Source: https://github.com/elizaos/eliza/blob/develop/packages/app/README.md

Execute the elizaOS setup command using bunx or npx for a no-install option.

```bash
bunx @elizaos/app setup
```

```bash
npx @elizaos/app setup
```

--------------------------------

### Install and Launch Eliza (Unix/macOS)

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/guides/onboarding-and-support.md

Use these commands for a fresh clone on Unix-like systems to initialize submodules and install dependencies, then launch the development server.

```bash
./install        # Unix / macOS (initializes submodules + installs deps)
# install.cmd    # Windows
bun run dev      # API on :31337, UI on :2138 with hot reload
```

--------------------------------

### Install and Run Text Adventure Game

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/examples-gallery/games.mdx

Navigate to the text-adventure example directory, set up environment variables, install dependencies, and run the game. Ensure OPENAI_API_KEY is configured in your .env file.

```bash
cd examples/text-adventure
cp .env.example .env  # add OPENAI_API_KEY
bun install
LOG_LEVEL=fatal bun run game.ts
```

--------------------------------

### Install Zig Compiler

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/agent-on-mobile.md

Installs the Zig compiler, version 0.13 or later, which is required for cross-compiling libllama.so. This is a one-time setup step.

```bash
sudo snap install zig --classic --beta && zig version
```

--------------------------------

### Build and Start Production Server

Source: https://github.com/elizaos/eliza/blob/develop/cloud/README.md

Commands to build the application for production and start the production server. Includes a separate command for testing security headers.

```bash
# Build and run in production mode
npm run build
npm run start

# Test security headers (in another terminal)
npm run test:security-headers
```

--------------------------------

### Install and Run Telegram Bot - TypeScript

Source: https://github.com/elizaos/eliza/blob/develop/packages/examples/telegram/README.md

Navigate to the TypeScript project directory, install dependencies using Bun, and then run the start script.

```bash
cd typescript && bun install && bun run start
```

--------------------------------

### Build and Run Desktop App from Source

Source: https://github.com/elizaos/eliza/blob/develop/packages/docs/apps/desktop.md

Clone the repository, install dependencies, build the project, and then run the desktop application in development mode.

```bash
git clone https://github.com/eliza-ai/eliza.git && cd eliza
bun install && bun run build
bun run dev:desktop
```