### Automated Installation with start.sh script

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This snippet shows how to clone the main Eliza repository and execute its provided start script. The script handles installation and setup automatically. Optional flags for verbose output or skipping nvm are mentioned.

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

# usage start.sh [-v|--verbose] [--skip-nvm]
./scripts/start.sh
```

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

### Automated Installation with eliza-starter

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This snippet provides commands to quickly set up and run the Eliza project using the eliza-starter repository. It involves cloning the starter repo, copying the environment file, installing dependencies, building the project, and starting the application.

```bash
git clone git@github.com:elizaos/eliza-starter.git
cd eliza-starter
cp .env.example .env
pnpm i && pnpm build && pnpm start
```

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

### Install and Start ElizaOS Globally (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Installs the ElizaOS CLI globally using npm and then starts the ElizaOS service with default settings. This is the recommended installation method.

```bash
# Install globally
npm install -g @elizaos/cli@beta
# Start ElizaOS
elizaos start
```

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

### Install and Run ElizaOS from Source (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Clones the ElizaOS repository, switches to the development branch, installs dependencies using bun, builds the project, and starts ElizaOS from the source code.

```bash
# Clone the repository
git clone git@github.com:elizaOS/eliza.git
cd eliza

# Switch to development branch
git checkout v2-develop

# Install dependencies
bun install

# Build the project
bun run build

# Start ElizaOS
bun start
```

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

### Cloning Eliza Repository for Manual Installation

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This snippet provides the initial steps for manual installation: cloning the main Eliza repository from GitHub and navigating into the project directory.

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

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

### Navigate and Start ElizaOS Project (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Changes the current directory to the newly created ElizaOS project and starts the project using the ElizaOS CLI.

```bash
# Navigate to your project directory
cd my-project-name
# Start your project
elizaos start
```

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

### Quick Start Setup (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/ton.md

Provides a quick start guide using a bash script to set up the environment and run a debug script. Requires setting environment variables for API keys.

```bash
# you should read the debug.sh first!

# if not provide the apikey, the response may very slow
export OPENAI_API_KEY=""

# if not provide the testnet apikey, the transfer action may not stable
# from https://t.me/toncenter to get your testnet apikey
export TON_RPC_API_KEY=""

# nvm use 23 && npm install -g bun
bash ./packages/plugin-ton/scripts/debug.sh
```

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

### Installing Project Dependencies Manually

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command installs all necessary project dependencies using the pnpm package manager. It's a standard step after cloning the repository during manual setup.

```bash
pnpm install
```

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

### Run ElizaOS with NPX (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Executes the ElizaOS CLI start command directly using npx, allowing testing without a global installation.

```bash
# Use directly with npx
npx @elizaos/cli@beta start
```

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

### Quick Start with Eliza Starter Template (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/README.md

Clones the Eliza starter repository, navigates into the directory, copies the example environment file, installs dependencies using Bun, builds the project, and starts the agent.

```bash
git clone https://github.com/elizaos/eliza-starter.git
cd eliza-starter
cp .env.example .env
bun i && bun run build && bun start
```

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

### Test and Publish ElizaOS Plugin (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Starts ElizaOS to test a newly created plugin and provides the command to publish the plugin when development is complete.

```bash
# Test your plugin
elizaos start
# Publish your plugin when ready
elizaos plugin publish
```

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

### Installing Optional Sharp Dependency

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command installs the optional 'sharp' dependency using pnpm, which might be necessary if encountering Sharp-related errors during installation or runtime.

```bash
pnpm install --include=optional sharp
```

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

### Installing System Dependencies in Ubuntu WSL

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/wsl.md

Installs essential build tools, Python 3, pip, git, curl, ffmpeg, and audio-related libraries required for the project.

```bash
sudo apt install -y \
    build-essential \
    python3 \
    python3-pip \
    git \
    curl \
    ffmpeg \
    libtool-bin \
    autoconf \
    automake \
    libopus-dev
```

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

### Start Eliza using the Starter Repository (pnpm)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/intro.md

Provides an automated way to set up and run Eliza by cloning the starter repository, copying the environment file, installing dependencies using pnpm, building the project, and starting the agent.

```bash
git clone https://github.com/elizaos/eliza-starter.git
cd eliza-starter
cp .env.example .env
pnpm i && pnpm build && pnpm start
```

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

### Starting Eliza Chat Client HTTP Server - Bash

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command starts the HTTP server for the Eliza chat client, allowing users to access the chat interface via a web browser. It is typically run from the main Eliza repository directory.

```bash
pnpm start:client
```

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

### Installing node-gyp Build Tools in Ubuntu WSL

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/wsl.md

Installs necessary packages for node-gyp to compile native addons, often required for Node.js dependencies.

```bash
sudo apt install -y nodejs-dev node-gyp
```

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

### Installing WSL on Windows

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/wsl.md

Opens PowerShell as Administrator and runs the command to install Windows Subsystem for Linux (WSL).

```powershell
wsl --install
```

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

### Troubleshooting Common Errors

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This snippet lists common error messages and corresponding troubleshooting steps, such as checking the working directory, running the start script with verbose logging, and checking console output.

```bash
- "characters not found": Check working directory
- `./scripts/start.sh -v` Run with logging
- Check console output
- [Open an issue](https://github.com/elizaOS/eliza/issues)
```

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

### Starting Agent with Multiple Character Files

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command starts the Eliza agent with multiple character configuration files. Multiple files can be specified by providing a comma-separated list to the '--characters' flag.

```bash
pnpm start --characters="characters/deep-thought.character.json,characters/sbf.character.json"
```

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

### Manage ElizaOS Project Plugins (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Lists available plugins for an ElizaOS project and demonstrates how to add a specific plugin using the ElizaOS CLI.

```bash
# List available plugins for a project
elizaos plugins list
# Add a plugin
elizaos plugins add @elizaos/plugin-discord
```

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

### Examples of ElizaOS setup-monorepo Command (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/setup-monorepo.md

Provides examples demonstrating how to use the command with default settings and with specific branch and directory options.

```bash
# Clone the default 'v2-develop' branch into the default './eliza' directory
elizaos setup-monorepo
```

```bash
# Clone the 'main' branch into a specific directory 'my-eliza-dev'
elizaos setup-monorepo --branch main --dir my-eliza-dev
```

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

### Automated Installation using Docker Compose

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This snippet outlines the steps to clone the Eliza repository and build/run it using Docker Compose. It requires Docker to be installed and is recommended for Linux-based systems. Permission issues with docker-compose commands may require sudo.

```bash
git clone git@github.com:elizaOS/eliza.git
cd eliza
docker-compose build
docker-compose up
```

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

### Installing pnpm in Ubuntu WSL

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/wsl.md

Downloads and runs the pnpm package manager installation script and sources the bash profile to make pnpm available.

```bash
curl -fsSL https://get.pnpm.io/install.sh | sh -
source ~/.bashrc
```

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

### Verifying ffmpeg Installation in Ubuntu WSL

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/wsl.md

Runs the ffmpeg command with the -version flag to check if ffmpeg is installed correctly and display its version information.

```bash
ffmpeg -version
```

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

### Copying and Editing Eliza Environment File - Bash

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

These commands are used to set up the default environment configuration. It copies the example environment file (.env.example) to a new .env file and then opens it for editing using the nano text editor.

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

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

### Create a New ElizaOS Project (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Initiates the creation of a new ElizaOS project using the CLI, either interactively or by specifying the project type directly.

```bash
# Create a new project with the interactive wizard
elizaos create
# Or specify project type directly
elizaos create --type project
```

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

### Automating better-sqlite3 Rebuild in package.json

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This JSON snippet shows how to add a 'postinstall' script to your package.json file. This script automatically runs 'npm rebuild better-sqlite3' after every 'pnpm install' or 'npm install', ensuring the dependency is correctly built.

```json
scripts: {
    "postinstall": "npm rebuild better-sqlite3"
}
```

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

### Install Eliza CLI and Create Project (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/intro.md

This snippet provides commands to install the Eliza CLI globally using npm or bun, and then create and start a new Eliza project from a folder using the CLI commands.

```bash
# make sure you have bun installed
npm install -g bun

# Install the CLI globally
npm install -g @elizaos/cli@beta # will be simpler after beta
# or install via bun
bun install -g @elizaos/cli@beta

# From a folder to install a project
elizaos create
cd new-agent
elizaos start
```

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

### Setup and Build Development Environment (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/gitbook.md

Sequence of Bun commands to install dependencies, build the plugin, and run tests for setting up the development environment.

```bash
bun install
bun run build
bun test
```

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

### Starting Agent with a Single Character File

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command starts the Eliza agent using pnpm and specifies a single character configuration file via the '--character' flag. Character files define the agent's personality and capabilities.

```bash
pnpm start --character="characters/deep-thought.character.json"
```

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

### Create a New ElizaOS Plugin Project (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Initiates the creation of a new ElizaOS plugin project using the ElizaOS CLI by specifying the plugin type.

```bash
# Create a new plugin project
elizaos create --type plugin
```

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

### Starting Interactive ElizaOS Project Creation - Bash

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/create.md

Shows how to initiate the interactive setup wizard for creating a basic ElizaOS project by running the `create` command without specifying all options upfront.

```bash
# Using npm create
npm create eliza

# Using npx
npx elizaos create
# Then follow the interactive prompts
```

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

### Starting an ElizaOS Project

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/overview.md

Shows the steps to start an ElizaOS project after navigating into its directory. The `elizaos start` command initiates the project's execution.

```bash
# Navigate to your project directory
cd my-agent-project

# Start the project
elizaos start
```

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

### Install Dependencies and Start Eliza Manually (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/README.md

Installs project dependencies using Bun, builds the project, and starts the Eliza agent. Notes that npm can also be used for build and start commands.

```bash
bun install
bun run build # npm will work too
bun start # npm will work too
```

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

### ElizaOS Plugin Publishing Options (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Demonstrates various options for publishing an ElizaOS plugin using the CLI, including testing the publish process, publishing to npm, and specifying platform compatibility.

```bash
# Test publish without making changes
elizaos plugin publish --test
# Publish to npm
elizaos plugin publish --npm
# Specify platform compatibility
elizaos plugin publish --platform node
```

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

### Example Commands for START_ANYONE Action

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/anyone.md

Provides examples of natural language phrases that an Eliza agent can interpret to initiate the START_ANYONE action, which starts the Anyone client.

```plaintext
"Can you start Anyone for me?"
"Initialize the Anyone client please"
"Launch Anyone for me"
```

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

### Initiate Fine-tuning in Test Mode

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/fine-tuning.md

Executes the npm script to start the fine-tuning process in an optional test mode, useful for verifying setup and data without a full training run.

```bash
npm run finetune:test
```

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

### Basic ElizaOS Project Startup

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/start.md

Illustrates the simplest way to start an ElizaOS project by navigating into the project directory and running the start command without any options.

```bash
cd my-agent-project
elizaos start
```

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

### Listing Available Eliza Plugins via CLI - Bash

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command uses the Eliza OS CLI tool (npx elizaos) to fetch and display a list of available plugins from the Eliza registry. This is an alternative to using the web interface.

```bash
$ npx elizaos plugins list
```

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

### Clean and Reinstall Dependencies with Bun (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Provides commands to clean the project, reinstall dependencies ignoring the lockfile, and rebuild the project using the bun package manager.

```bash
# Clean and reinstall
bun clean
bun install --no-frozen-lockfile
bun build
```

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

### Building the Project Manually

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command compiles the project, likely including TypeScript compilation. It's a necessary step after installing dependencies before running the application.

```bash
pnpm build
```

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

### Contribute to ElizaOS Core (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/intro.md

This snippet outlines the steps to clone the ElizaOS core repository, switch to the development branch, install dependencies, build the project, and start the application for contribution.

```bash
# Clone the repository
git clone git@github.com:elizaOS/eliza.git
cd eliza

# We are currently on the v2-develop branch
git checkout v2-develop

# Install dependencies and build
bun install
bun run build

# Start ElizaOS
bun start
```

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

### Set Environment Variables for ElizaOS Start

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/start.md

Demonstrates how to set environment variables directly on the command line when running the ElizaOS start command, using OPENAI_API_KEY as an example.

```bash
# Set environment variables directly
OPENAI_API_KEY=your-api-key elizaos start
```

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

### Initializing and Updating Git Submodules

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command initializes and updates any Git submodules configured in the repository. This is used here to download sample character files from a separate repository.

```bash
git submodule update --init
```

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

### Installing Dependencies and Starting Eliza Bot (bun)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/README.md

Installs project dependencies using bun and then starts the Eliza bot application. Requires Node.js 23+ and bun.

```Shell
bun i
bun start
```

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

### Fixing Script Permission Issues

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This snippet provides commands to resolve permission issues when executing the start script. It includes commands for Linux/macOS using chmod and for Windows using Set-ExecutionPolicy.

```bash
sudo chmod +x scripts/start.sh  # Linux/macOS
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser  # Windows
```

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

### Start ElizaOS with Configuration

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/start.md

Shows how to use the `--configure` option with the ElizaOS start command to reconfigure services and AI models before launching the project.

```bash
elizaos start --configure
```

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

### Install and Run ElizaOS with Bun

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/news/2025-03-30.md

Commands to install project dependencies, build the application, and start the ElizaOS server using the Bun runtime, typically executed after cloning the repository and switching to a specific development branch.

```Shell
bun install
bun run build
bun start
```

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

### Starting ElizaOS CLI (Beta)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/news/2025-03-31.md

These commands demonstrate how to start the ElizaOS CLI tool, specifically referencing the beta version. The instructions are part of proposed updates to the CLI documentation, linking to official guides and mentioning free OpenRouter models.

```Shell
npx @elizaos/cli@beta start
```

```Shell
elizaos start
```

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

### Starting Interactive ElizaOS Plugin Creation - Bash

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/create.md

Shows how to initiate the interactive setup wizard specifically for creating an ElizaOS plugin, using the `-t plugin` flag or the `npm create` shorthand, and then following the prompts.

```bash
# Using npm create
npm create eliza -t plugin
# Or with shorthand syntax
npm create eliza plugin my-plugin-name

# Using npx
npx elizaos create -t plugin
# Then follow the interactive prompts
```

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

### Installing Development Dependencies (Bun)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/aptos.md

Command to install project dependencies using the Bun package manager during development setup.

```bash
bun install
```

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

### Creating a New ElizaOS Project

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/core/project.md

Provides command-line instructions using npm or npx to initialize a new ElizaOS project, guiding the user through setup steps like naming and database selection.

```bash
# Using npm
npm create eliza@beta

# Or using npx
npx @elizaos/cli@beta create
```

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

### Enabling CUDA GPU Acceleration for Eliza - Bash

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command is used to download and configure the necessary components (node-llama-cpp source) to enable CUDA support for GPU acceleration with Eliza, provided CUDA Toolkit, cuDNN, and cuBLAS are already installed.

```bash
npx --no node-llama-cpp source download --gpu cuda
```

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

### Listing Docker Images

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command lists all Docker images present on the system. It's a utility command for managing Docker resources, often used during troubleshooting or cleanup.

```bash
sudo docker images
```

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

### Install Development Dependencies (Bun)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/letzai.md

Installs project dependencies using the Bun package manager during development setup.

```bash
bun install
```

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

### Rebuild Specific Package with Bun (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Demonstrates how to rebuild a specific package, such as 'better-sqlite3', using the bun package manager to resolve potential plugin issues.

```bash
# Rebuild problematic packages
bun rebuild better-sqlite3
```

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

### Setup Environment File - Shell

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/sgx.md

Copies the example environment file (.env.example) to create the active environment file (.env). This file must then be edited with specific configuration details.

```Shell
cp .env.example .env
```

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

### Start Eliza using the Main Repository (script)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/intro.md

Provides an alternative automated way to set up and run Eliza by cloning the main eliza repository, navigating into the directory, and executing the provided start script.

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

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

### Build and Start ElizaOS Project

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/start.md

Illustrates how to combine the build process with the startup command using the `--build` option, ensuring the project is compiled before execution.

```bash
elizaos start --build
```

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

### Installing Node.js via nvm in Ubuntu WSL

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/wsl.md

Downloads and runs the nvm (Node Version Manager) installation script, sources the bash profile, installs Node.js version 23, and sets it as the default.

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
source ~/.bashrc
nvm install 23
nvm use 23
```

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

### Install Dependencies with Bun - Bash

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/core/README-TESTS.md

Installs the project dependencies listed in the package.json file within the core package directory using the Bun package manager.

```bash
bun install
```

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

### Start ElizaOS on Custom Port

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/start.md

Demonstrates how to specify a custom port for the ElizaOS HTTP API server using the `--port` option when starting the project.

```bash
elizaos start --port 8080
```

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

### Eliza Plugin Installation Configuration (JSON)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/lightning.md

Example JSON configuration to add the @elizaos/plugin-lightning to your Eliza OS setup, enabling its features.

```json
{
  "plugins": ["@elizaos/plugin-lightning"]
}
```

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

### Updating Ubuntu Packages in WSL

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/wsl.md

Runs apt update and apt upgrade commands to ensure all installed packages in the Ubuntu WSL distribution are up to date.

```bash
sudo apt update && sudo apt upgrade -y
```

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

### Start Eliza Server with Bun (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/clients/slack.md

Executes the server startup script using the Bun runtime. This command typically runs the main application entry point as defined in the project's package.json or similar configuration.

```bash
bun start
```

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

### Running Multiple Agents via Command Line (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/core/agents.md

Provides a command-line example using `pnpm start` to launch the runtime with multiple agents specified by their character file paths passed to the `--characters` flag.

```bash
pnpm start --characters="characters/agent1.json,characters/agent2.json"
```

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

### Install Dependencies and Build Eliza OS

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/messari-ai-toolkit.md

Installs project dependencies using Bun and then builds the Eliza OS project. This is a prerequisite step before installing plugins.

```bash
bun install
bun build
```

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

### Create and Start Eliza Project (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/intro.md

This snippet shows the basic commands to create a new Eliza project interactively using the CLI and then navigate into the project directory to start it.

```bash
# Create a new project through interactive setup
elizaos create # will be simpler after beta

# Navigate to your project directory
cd my-project-name

# Start your project
elizaos start
```

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

### Querying Blockchain Information (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/ankr.md

Examples of natural language prompts to get general blockchain statistics and top currencies using the Ankr plugin. Requires specifying the blockchain chain.

```bash
# Get blockchain stats
Show me stats for [chain]eth[/chain]

# Get top currencies
Show me the top currencies on [chain]eth[/chain]
```

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

### Removing All Docker Build Cache

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command removes all Docker build cache. This can free up disk space and ensure that subsequent builds start fresh, which can help resolve caching-related issues.

```bash
docker builder prune -a -f
```

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

### Example: Get Token Balance (bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/bnb.md

Example command usage to get the balance of a specific token for an address on the BSC chain.

```bash
Get the USDC balance of 0x1234567890 on BSC.
```

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

### Basic ElizaOS Development Mode

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/dev.md

Demonstrates navigating into a project directory and starting the development server using the default settings.

```bash
cd my-agent-project
elizaos dev
```

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

### Querying Transaction Details (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/ankr.md

Examples of natural language prompts to retrieve the latest transactions for an address or get details for a specific transaction hash using the Ankr plugin. Requires contract address or transaction hash and the chain.

```bash
# Get transactions by address
Show me the latest transactions for address [contract]0xd8da6bf26964af9d7eed9e03e53415d37aa96045[/contract] [chain]eth[/chain]

# Get transaction details
Show me details for transaction [txHash]0x748eeb4a15ba05736a9397a07ca86f0184c0c1eca53fa901b28a412d1a3f211f[/txHash] [chain]eth[/chain]
```

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

### Enabling and Starting Eliza Service (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/remote-deployment.md

Reloads the systemd manager configuration, enables the eliza service to start on boot, and immediately starts the eliza service.

```bash
sudo systemctl daemon-reload
sudo systemctl enable eliza
sudo systemctl start eliza
```

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

### Configuring pnpm to use Specific Node Version

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command configures pnpm to use a specific global Node.js version (23.3.0 in this example). This is useful if pnpm is bundled with a different Node version than intended, potentially ignoring nvm settings.

```bash
pnpm env use --global 23.3.0
```

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

### Install TrustDB Plugin

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/trustdb.md

Installs the @elizaos/plugin-trustdb package using npm.

```bash
npm install @elizaos/plugin-trustdb
```

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

### Installing the QuickIntel Plugin

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/quick-intel.md

Command to install the @elizaos/plugin-quickintel package using the Bun package manager.

```bash
bun install @elizaos/plugin-quickintel
```

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

### Updating Package Managers for Package Issues

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This snippet provides commands to update package managers on different operating systems (Linux, macOS) as a step to resolve package-related installation issues. Windows instructions are noted as requiring admin privileges.

```bash
## Linux
sudo apt update

## MacOS
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew update

## Windows
# Run as admin
```

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

### Running Tests with npm (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/project-starter/README-TESTS.md

Provides standard npm commands to execute the test suite, including options for running all tests, generating coverage reports, targeting specific files, and enabling watch mode for continuous testing during development.

```bash
# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Run specific test file
npm test -- actions.test.ts

# Run tests in watch mode
npm test -- --watch
```

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

### Starting an ElizaOS Project (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/core/project.md

This command-line snippet shows how to start an ElizaOS project using the ElizaOS command-line interface (CLI). The `elizaos start` command initiates the project, loading the configuration and launching the agents defined within it.

```Bash
elizaos start
```

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

### Example Response for GET /hello (JSON)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/rest/get-hello.api.mdx

An example JSON response returned by the GET /hello endpoint upon success (HTTP status 200). It contains a simple 'message' field.

```json
{
  "message": "Hello World!"
}
```

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

### Initialize Eliza Plugin Project with Starter Template - Bash

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/tutorials/nader_tutorial_35min.md

Commands to clone the Eliza plugin starter template, navigate into the directory, install dependencies, compile TypeScript, and run a mock Eliza instance for testing.

```bash
git clone https://github.com/elizaOS/eliza-plugin-starter.git
cd eliza-plugin-starter
pnpm install
pnpm tsc
pnpm mock-eliza --characters=./characters/eternalai.character.json
```

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

### Clone Repository and Install Dependencies

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/fine-tuning.md

Commands to clone the twitter-scraper-finetune repository from GitHub and install its Node.js dependencies using npm.

```bash
git clone git@github.com:elizaOS/twitter-scraper-finetune.git
cd twitter-scraper-finetune
npm install
```

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

### Install Browser Plugin

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/browser.md

Installs the @elizaos/plugin-browser package using npm.

```bash
npm install @elizaos/plugin-browser
```

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

### Example Output When CLI Not Globally Installed

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/update.md

Shows the console output when attempting to update the CLI using `elizaos update --cli` but the CLI is not installed globally, providing instructions for global installation.

```text
The CLI update is only available for globally installed CLI.
To update a local installation, use your package manager manually.
For global installation, run: npm install -g @elizaos/cli@beta
```

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

### Building and Starting ElizaOS Project (bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/cli/README.md

Commands to build the ElizaOS project for production and then start the built application. Can be run via Bun or the ElizaOS CLI.

```bash
bun run build
bun run start
# Or with the CLI directly:
elizaos start
```

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

### GET_CURRENT_NONCE Action Example

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/genlayer.md

Example of the natural language command to get the current transaction nonce for a given address on GenLayer.

```plaintext
"Get current nonce for address 0xE2632..."
```

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

### ElizaOS Start Command Usage

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/start.md

Shows the basic command structure for launching an ElizaOS project or agent in production mode, including placeholder for various options.

```bash
elizaos start [options]
```

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

### Install Eliza OS Initia Plugin (Bun)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/static/packages/plugins/initia.md

Installs the @elizaos/plugin-initia package using the Bun package manager.

```bash
bun install @elizaos/plugin-initia
```

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

### Install Opacity Adapter (Bun)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/static/packages/plugins/opacity.md

Installs the @elizaos/adapter-opacity package using the Bun package manager.

```bash
bun add @elizaos/adapter-opacity
```

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

### Install Bun Globally - Bash

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/core/README-TESTS.md

Installs the Bun runtime globally using npm. Bun is required to run the project and its tests.

```bash
npm install -g bun
```

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

### Example FerePro API Queries via Plugin

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/static/packages/plugins/ferePro.md

Examples of natural language queries that can be sent to the FerePro API through the ElizaOS plugin to get market insights.

```TypeScript
'What are the top 5 cryptocurrencies?'
```

```TypeScript
'Compare Ethereum and Bitcoin for the past 6 months'
```

```TypeScript
'Compare top 3 coins against Bitcoin in the last 3 months'
```

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

### Install Project Dependencies with Bun

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/dkg.md

Installs all project dependencies listed in the package.json file using the Bun package manager. This is typically done after cloning the repository during development setup.

```bash
bun install
```

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

### Install Messari AI Toolkit Plugin (Eliza Starter) - Bash

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/static/packages/plugins/messari-ai-toolkit.md

This command uses the Bun package manager to add the Messari AI Toolkit plugin to an Eliza Starter project.

```bash
bun add github:messari/plugin-messari-ai-toolkit
```

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

### Install QuickIntel Plugin (Bun)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/static/packages/plugins/quick-intel.md

Installs the @elizaos/plugin-quickintel package using the Bun package manager.

```bash
bun install @elizaos/plugin-quickintel
```

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

### Example JSONL Training Data Format

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/fine-tuning.md

Illustrates the recommended JSONL format for creating training datasets. Each line is a JSON object with a 'text' key containing a training example.

```json
{"text": "Your training example here"}
{"text": "Another training example"}
```

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

### Example .env Configuration (Text)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/remote-deployment.md

Provides an example configuration for the `.env` file, showing settings for character storage, Discord API keys, and AI provider keys.

```text
USE_CHARACTER_STORAGE=true

# Discord Configuration
DISCORD_APPLICATION_ID=...
DISCORD_API_TOKEN=...

# AI Provider Keys
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-...
```

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

### Starting Eliza in SGX Environment (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/sgx.md

Commands to build Eliza and start it within a Gramine SGX environment. The SGX environment variable is set to enable the SGX plugin. Examples for starting the default character and a specific character are provided.

```bash
bun i
bun build

# Start default character
SGX=1 make start
# Start specific character
SGX=1 make start -- --character "character/trump.character.json"
```

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

### Start ElizaOS with DKG Character (Bun)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/static/packages/plugins/dkg.md

Starts the ElizaOS application using the Bun runtime, specifying a character configuration file that utilizes the DKG plugin. This demonstrates example usage of the plugin.

```bash
bun start --characters="characters/chatdkg.character.json"
```

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

### Example Response for List Stored Character Files API

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/rest/list-stored-characters.api.mdx

An example of the successful 200 response body for the GET /storage endpoint, showing the structure containing an array of file names.

```json
{
  "files": [
    "string"
  ]
}
```

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

### TrustScoreDatabase Core Methods

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/trustdb.md

Shows examples of getting or creating a recommender and updating their associated metrics.

```typescript
// Get or create a recommender
const recommender = await trustDB.getOrCreateRecommender({
  address: 'wallet-address',
  telegramId: 'user-id'
});

// Update recommender metrics
trustDB.updateRecommenderMetrics({
  recommenderId: 'uuid',
  trustScore: 85.5,
  totalRecommendations: 10
  // ... other metrics
});
```

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

### Usage of ElizaOS setup-monorepo Command (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/setup-monorepo.md

Shows the basic command structure with optional arguments for cloning the ElizaOS monorepo.

```bash
elizaos setup-monorepo [options]
```

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

### Getting and Setting Participant State in ElizaOS (TypeScript)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/core/rooms.md

Demonstrates how to retrieve and update a participant's state within a specific room using the ElizaOS runtime. It shows examples for getting the current state and setting it to 'FOLLOWED'.

```typescript
// Get a participant's state in a room
const state = await runtime.getParticipantUserState(roomId, entityId);
// Returns: 'FOLLOWED', 'MUTED', or null

// Set a participant's state in a room
await runtime.setParticipantUserState(roomId, entityId, 'FOLLOWED');
```

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

### Getting Help for ElizaOS Create Command - Bash

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/create.md

Provides different methods to access help documentation for the `create` command, noting the recommended way via `npx` and how `npm create help` works differently than the standard `--help` flag.

```bash
# Recommended way to view detailed help
npx elizaos create --help

# Quick help overview with npm create
npm create eliza help

# The standard --help flag with npm doesn't work as expected
# as npm intercepts it and shows npm's own help
```

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

### List and Get ElizaOS Agents (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/agent.md

Provides examples for listing all available agents, listing in JSON format, getting detailed information for a specific agent, and saving agent configuration to a file using the ElizaOS CLI.

```bash
# List all agents with their status
elizaos agent list

# List in JSON format
elizaos agent list --json

# Get detailed information about an agent
elizaos agent get --name customer-support

# Save agent configuration to file
elizaos agent get --name customer-support --json --output ./my-agent.json
```

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

### Install GitHub Client

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/static/packages/clients/github.md

Installs the Eliza GitHub client package using the Bun package manager.

```bash
bun add @elizaos/client-github
```

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

### Develop and Test an ElizaOS Plugin (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/publish.md

Outlines the standard workflow for developing and testing an ElizaOS plugin after creation. It includes installing dependencies using `bun install`, starting the development server with `elizaos dev`, and running tests with `elizaos test`.

```bash
# Install dependencies
bun install

# Develop your plugin (edit src/, etc.)
elizaos dev

# Test your plugin
elizaos test
```

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

### ElizaOS Plugin Development Setup

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/twilio.md

Commands to install dependencies and build the ElizaOS Twilio plugin during development.

```bash
# Install dependencies
bun install

# Build the plugin
bun build
```

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

### Creating a New ElizaOS Project

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/overview.md

Demonstrates how to create a new ElizaOS project using the `elizaos create` command. It shows both the interactive wizard approach and specifying the project name directly.

```bash
# Create a new project using the interactive wizard
elizaos create

# Or specify a name directly
elizaos create my-agent-project
```

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

### Example: Extending an Existing Track (udio.extend) (TypeScript)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/udio.md

A specific example demonstrating the use of 'udio.extend' to continue an existing audio track, specifying the continuation prompt, details of the original audio, a specific start time for the extension, and additional lyrics.

```typescript
const extended = await eliza.execute('udio.extend', {
  prompt: 'Continue with the same energy and mood',
  audioConditioningPath: '/path/to/original.mp3',
  audioConditioningSongId: 'original-123',
  cropStartTime: 60, // Start continuation from 1 minute mark
  customLyrics: 'Verse 2: Continuing the story...',
});
```

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

### Initializing Mock Database Adapter

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/core/README-automated.md

Shows the process of creating an instance of `MockDatabaseAdapter` and initializing it asynchronously using the `init` method.

```typescript
const mockAdapter = new MockDatabaseAdapter();
await mockAdapter.init();
```

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

### Install MerkleTrade Plugin via Configuration

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/static/packages/plugins/merkle.md

Shows the JSON configuration required to include the @elizaos/plugin-merkle plugin in the Eliza OS setup.

```json
{
  "plugins": ["@elizaos/plugin-merkle"]
}
```

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

### Build and Lint ElizaOS Plugin

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/bootstrap.md

Steps to install development dependencies, build the plugin, and run linting checks using Bun.

```bash
bun install
```

```bash
bun run build
```

```bash
bun run lint
```

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

### Rebuilding better-sqlite3 Dependency

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command attempts to rebuild the 'better-sqlite3' dependency using pnpm, which can resolve issues related to this specific package.

```bash
pnpm rebuild better-sqlite3
```

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

### Installing Dependencies and Building Eliza (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/tutorials/nader_tutorial_15min.md

Installs project dependencies using pnpm and then builds the Eliza framework. This prepares the project for running the agent.

```bash
pnpm install
pnpm build
```

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

### Example Basic Market Query (TypeScript)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/ferePro.md

A TypeScript string literal demonstrating a basic query to the FerePro API to get the top 5 cryptocurrencies.

```typescript
'What are the top 5 cryptocurrencies?';
```

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

### Import TTS Generation Plugin (TypeScript)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/static/packages/plugins/tts.md

Imports the TTSGenerationPlugin class from the installed package, making it available for use in your TypeScript application or ElizaOS setup.

```typescript
import { TTSGenerationPlugin } from '@elizaos/plugin-tts';
```

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

### Building and Testing ElizaOS LightLink Plugin (Bun)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/lightlink.md

Standard Bun commands for installing dependencies, building the plugin, and running its test suite during development.

```shell
bun install
bun run build
bun test
```

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

### Installing ElizaOS Beta via npm

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/news/2025-03-20.md

Provides the command-line instruction to initialize a new ElizaOS project using the beta version of the npm package.

```Shell
npm create eliza@beta
```

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

### Example: Execute a Proposal

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/evm.md

Provides an example command for executing a proposal that has been successfully queued for a governor contract.

```command
Execute the proposal with ID 1 on the 0xdeadbeef00000000000000000000000000000000 governor on Ethereum.
```

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

### Clean Up Docker Environment (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/quickstart.md

Provides commands to remove all Docker images and prune the Docker build cache to clean up the Docker environment.

```bash
# Clean up Docker environment
docker rmi -f $(docker images -aq)
docker builder prune -a -f
```

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

### Writing New Tests with Mock Utilities (TypeScript)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/project-starter/README-TESTS.md

Demonstrates the process of writing a new test case using core utilities like `createMockRuntime`, `createMockMessage`, and `createMockState` to set up a standardized test environment and then documenting the test result.

```typescript
it('should test my new feature', async () => {
  const runtime = createMockRuntime();
  const message = createMockMessage('Test message');
  const state = createMockState();

  const result = await myFeature(runtime, message, state);

  expect(result).toBeTruthy();
  documentTestResult('My feature test', result);
});
```

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

### Switching to Develop Branch

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command switches the current Git branch to 'develop'. This is recommended if you plan on contributing to the project or working with the latest development code.

```bash
git checkout develop
```

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

### Initialize New ElizaOS Project (Bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/blog/v1-v2.mdx

Command to quickly initialize a new ElizaOS project using the beta version of the CLI, simplifying the setup process compared to manual repository cloning and building.

```Bash
npm create eliza@beta
```

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

### Configure Agent with Plugin in agent.json

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/blog/add-plugins.mdx

Illustrates how to add an installed plugin to the agent's configuration file (agent.json) so that it is automatically loaded when the agent starts.

```json
{
  "name": "MyAgent",
  "plugins": ["@elizaos/plugin-example"]
}
```

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

### Get MultiChain Provider Info

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/multichain.md

Example TypeScript code to access the 'multichain' provider via Eliza OS to retrieve consolidated portfolio information and network status.

```typescript
const portfolioInfo = await eliza.getProvider('multichain');
// Returns consolidated portfolio including:
// - Balances across all chains
// - USD values
// - Network status
```

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

### Build Eliza Project

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/faq.md

Build the Eliza project after installing dependencies.

```bash
pnpm build
```

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

### Removing All Docker Images

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/quickstart.md

This command forcefully removes all Docker images from the system. It's a drastic cleanup step, useful for clearing out old or problematic images.

```bash
docker rmi -f $(docker images -aq)
```

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

### Installing the ElizaOS Compass Plugin

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/compass.md

Provides the command-line instructions to add the Compass plugin using the ElizaOS CLI and build the project.

```Bash
npx elizaos plugins add @elizaos-plugins/plugin-compass
bun run build
```

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

### ElizaOS Plugin Development Commands (bash)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/plugin-starter/README.md

Provides standard npm commands for starting development with hot-reloading, building the plugin for distribution, and running tests.

```bash
# Start development with hot-reloading
npm run dev

# Build the plugin
npm run build

# Test the plugin
npm run test
```

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

### Example Output for Updating ElizaOS CLI

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/docs/cli/update.md

Shows the typical console output when the `elizaos update --cli` command successfully updates the globally installed ElizaOS CLI.

```text
Checking for ElizaOS CLI updates...
Updating ElizaOS CLI from 1.3.5 to 1.4.0...
Updating Eliza CLI to version: 1.4.0
Successfully updated Eliza CLI to 1.4.0
Please restart your terminal for the changes to take effect.
ElizaOS CLI has been successfully updated!
```

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

### Install and Build ElizaOS Compass Plugin

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/static/packages/plugins/compass.md

These commands install the @elizaos-plugins/plugin-compass using the ElizaOS CLI and then build the project using Bun. This prepares the plugin for use within the ElizaOS ecosystem.

```bash
npx elizaos plugins add @elizaos-plugins/plugin-compass
bun run build
```

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

### Changing Project Directory Ownership in Ubuntu WSL

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/guides/wsl.md

Recursively changes the owner and group of the specified project directory to the current user, resolving potential permission issues.

```bash
sudo chown -R $USER:$USER ~/path/to/eliza
```

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

### Example: Queue a Proposal

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/evm.md

Demonstrates an example command for queuing a proposal that has met the required voting threshold for a governor contract.

```command
Queue the proposal to the 0xdeadbeef00000000000000000000000000000000 governor on Ethereum.
```

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

### Example: Transfer Native Tokens

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/evm.md

Demonstrates how to initiate a native token transfer on the same chain using the Transfer action.

```command
// Example: Transfer 1 ETH
Transfer 1 ETH to 0x742d35Cc6634C0532925a3b844Bc454e4438f44e
```

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

### PostgreSQL Extension Setup

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/versioned_docs/version-0.25.9/core/database.md

Installs the necessary PostgreSQL extensions for vector search (`vector`) and fuzzy string matching (`fuzzystrmatch`), required for specific features of the PostgreSQL adapter.

```SQL
CREATE EXTENSION IF NOT EXISTS vector;
CREATE EXTENSION IF NOT EXISTS fuzzystrmatch;
```

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

### Example Usage of TrustScoreDatabase

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/static/packages/plugins/trustdb.md

Demonstrates initializing the database, adding a recommender, and updating token performance metrics using the TrustScoreDatabase instance.

```typescript
import { TrustScoreDatabase } from '@elizaos/plugin-trustdb';

// Initialize database
const trustDB = new TrustScoreDatabase(db);

// Add a recommender
const recommender = {
  id: 'uuid',
  address: 'wallet-address',
  telegramId: 'telegram-id'
};
trustDB.addRecommender(recommender);

// Track token performance
const performance = {
  tokenAddress: 'token-address',
  priceChange24h: 10.5,
  volumeChange24h: 25.3
  // ... other metrics
};
trustDB.upsertTokenPerformance(performance);
```

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

### Building Note Link Hierarchy in Obsidian Vault (TypeScript)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/obsidian.md

Provides an example of building a hierarchical structure based on the links and backlinks between notes, starting from a specified note.

```typescript
const hierarchy = buildLinkHierarchy('path/to/start-note.md');
```

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

### Installing Eliza OS NFT Generation Plugin (Bun)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/nft-generation.md

Installs the Eliza OS NFT generation plugin using the Bun package manager.

```bash
bun install @elizaos/plugin-nft-generation
```

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

### Executing GET_CURVES_SELL_PRICE Action in ElizaOS

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/form.md

Example of calling the GET_CURVES_SELL_PRICE action via the ElizaOS runtime to get a price quote for selling curves tokens, specifying the subject address, amount, and formula.

```typescript
await runtime.processAction('GET_CURVES_SELL_PRICE', {
  subject: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
  amount: 1,
  formula: 'QUADRATIC',
});
```

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

### Installing Aptos Plugin (Bun)

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/aptos.md

Command to install the @elizaos/plugin-aptos package using the Bun package manager.

```bash
bun install @elizaos/plugin-aptos
```

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

### Executing GET_CURVES_BUY_PRICE Action in ElizaOS

Source: https://github.com/wtfsayo/eliza/blob/v2-develop/packages/docs/packages/plugins/form.md

Example of calling the GET_CURVES_BUY_PRICE action via the ElizaOS runtime to get a price quote for buying curves tokens, specifying the subject address, amount, and formula.

```typescript
await runtime.processAction('GET_CURVES_BUY_PRICE', {
  subject: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
  amount: 1,
  formula: 'QUADRATIC',
});
```