Skip to content
/ eliza-starter Public template
forked from elizaOS/eliza-starter

Quickstart for ElizaOS powered agents.

License

Notifications You must be signed in to change notification settings

hanzoai/eliza-starter

This branch is 22 commits behind elizaOS/eliza-starter:main.

Folders and files

NameName
Last commit message
Last commit date
Jan 17, 2025
Jan 15, 2025
Jan 14, 2025
Jan 13, 2025
Jan 5, 2025
Jan 16, 2025
Jan 17, 2025
Jan 17, 2025
Jan 16, 2025
Jan 16, 2025
Jan 15, 2025
Jan 15, 2025
Nov 20, 2024

Repository files navigation

Eliza

Edit the character files

Open src/character.ts to modify the default character. Uncomment and edit.

Custom characters

To load custom characters instead:

  • Use pnpm start --characters="path/to/your/character.json"
  • Multiple character files can be loaded simultaneously

Add clients

# in character.ts
clients: [Clients.TWITTER, Clients.DISCORD],

# in character.json
clients: ["twitter", "discord"]

Duplicate the .env.example template

cp .env.example .env

* Fill out the .env file with your own values.

Add login credentials and keys to .env

DISCORD_APPLICATION_ID="discord-application-id"
DISCORD_API_TOKEN="discord-api-token"
...
OPENROUTER_API_KEY="sk-xx-xx-xxx"
...
TWITTER_USERNAME="username"
TWITTER_PASSWORD="password"
TWITTER_EMAIL="your@email.com"

Install dependencies and start your agent

pnpm i && pnpm start

Note: this requires node to be at least version 22 when you install packages and run the agent.

Run with Docker

Build and run Docker Compose (For x86_64 architecture)

Edit the docker-compose.yaml file with your environment variables

services:
    eliza:
        environment:
            - OPENROUTER_API_KEY=blahdeeblahblahblah

Run the image

docker compose up

Build the image with Mac M-Series or aarch64

Make sure docker is running.

# The --load flag ensures the built image is available locally
docker buildx build --platform linux/amd64 -t eliza-starter:v1 --load .

Edit the docker-compose-image.yaml file with your environment variables

services:
    eliza:
        environment:
            - OPENROUTER_API_KEY=blahdeeblahblahblah

Run the image

docker compose -f docker-compose-image.yaml up

About

Quickstart for ElizaOS powered agents.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 94.0%
  • Dockerfile 5.2%
  • Shell 0.8%