Skip to content

Latest commit

 

History

History
191 lines (141 loc) · 3.64 KB

start-script.md

File metadata and controls

191 lines (141 loc) · 3.64 KB

🤖 Eliza Start Script

A powerful, cross-platform launcher for your AI companion

🚀 Quick Start

# Linux/macOS from eliza root directory
./scripts/start.sh

💻 System Requirements

🐧 Linux
  • Bash shell
  • sudo access
  • APT package manager
  • 2GB free disk space
🍎 macOS
  • macOS 10.15 or higher
  • Command Line Tools
  • Admin access
  • 2GB free disk space
🪟 Windows (WSL2)

Requirements:

  • Windows 10 version 2004+ or Windows 11
  • 8GB RAM minimum
  • Virtualization enabled in BIOS
  • Admin access to install WSL2

Installation Steps:

  1. Enable WSL2:

    # Run in PowerShell as Administrator
wsl --install

  2. Install Ubuntu from Microsoft Store or:

    wsl --install -d Ubuntu

  3. Restart your computer

  4. Set up Ubuntu:

    • Open Ubuntu from Start Menu
    • Create username and password when prompted
    • Run updates: 
      sudo apt update && sudo apt upgrade -y

Now you can follow the Linux instructions!

✨ Features

Feature Description
🔍 OS Detection Automatically adapts to your platform
🛠️ Zero Config Installs all dependencies automatically
📦 Node.js Manages versions and packages seamlessly
🎭 Characters Full character management interface
🔄 Updates One-click updates and version management
⚙️ Environment Guided configuration setup

🎮 Usage

Command Line Options

start.sh [-v|--verbose] [--skip-nvm]
Option Description
-v, --verbose Show detailed progress
--skip-nvm Use system Node.js

🔄 Starting and Updating Eliza

Action Description
Start Launch current version
Update Install latest updates
Reinstall Fresh installation

🎭 Character Management

Creating New Characters
  1. Select Create New
  2. Enter character name
  3. Customize in editor
  4. Save & deploy
Using Existing Characters
  1. Select Use Existing
  2. Choose characters:
    • Select each: X
    • Select All: Ctrl+A
    • Confirm: ENTER
Character Actions

Single Character:

  • ▶️ Run
  • ✏️ Edit
  • 🗑️ Delete

Multiple Characters:

  • ▶️ Run All
  • 🗑️ Delete All

⚙️ Configuration

🛟 Troubleshooting

Common Solutions

🔒 Permission Issues 
# Linux/macOS
sudo chmod +x scripts/start.sh

# Windows
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
📦 Node.js Issues
  • Required: Node.js 22+
  • Use --skip-nvm for system Node
  • Check PATH configuration
🔧 Package Manager Issues
  • Linux: sudo apt update
  • macOS: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  • Windows: Run as Administrator

🚨 Common Errors

| characters not found | Check working directory |

📝 Notes

  • Temporary files: /tmp/eliza_*
  • Config location: ./config
  • Characters: ./characters/*.json

🆘 Support

Need help? Try these steps:

  1. Run with verbose logging: 
    ./scripts/start.sh -v
  2. Check console output
  3. Open an issue
Made with ❤️ by the ai16z team