Skip to content

Commit 44b1e55

Browse files
pgoospgoos
authored
Merge branch 'main' into test/integration-test-poc
2 parents bb0563c + 1c9a5a1 commit 44b1e55

File tree

25 files changed

+709
-211
lines changed

25 files changed

+709
-211
lines changed

‎.env.example

+15
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ DISCORD_VOICE_CHANNEL_ID= # The ID of the voice channel the bot should join (opt
55

66
# AI Model API Keys
77
OPENAI_API_KEY= # OpenAI API key, starting with sk-
8+
SMALL_OPENAI_MODEL= # Default: gpt-4o-mini
9+
MEDIUM_OPENAI_MODEL= # Default: gpt-4o
10+
LARGE_OPENAI_MODEL= # Default: gpt-4o
11+
EMBEDDING_OPENAI_MODEL= # Default: text-embedding-3-small
12+
IMAGE_OPENAI_MODEL= # Default: dall-e-3
813

914
# Eternal AI's Decentralized Inference API
1015
ETERNALAI_URL=
@@ -18,6 +23,7 @@ GOOGLE_GENERATIVE_AI_API_KEY= # Gemini API key
1823

1924
ALI_BAILIAN_API_KEY= # Ali Bailian API Key
2025
VOLENGINE_API_KEY= # VolEngine API Key
26+
NANOGPT_API_KEY= # NanoGPT API Key
2127

2228
HYPERBOLIC_API_KEY= # Hyperbolic API Key
2329
HYPERBOLIC_MODEL=
@@ -96,11 +102,20 @@ MEDIUM_GROQ_MODEL= # Default: llama-3.3-70b-versatile
96102
LARGE_GROQ_MODEL= # Default: llama-3.2-90b-vision-preview
97103
EMBEDDING_GROQ_MODEL= # Default: llama-3.1-8b-instant
98104

105+
# NanoGPT Configuration
106+
SMALL_NANOGPT_MODEL= # Default: gpt-4o-mini
107+
MEDIUM_NANOGPT_MODEL= # Default: gpt-4o
108+
LARGE_NANOGPT_MODEL= # Default: gpt-4o
109+
99110
#LlamaLocal Configuration
100111
LLAMALOCAL_PATH= # Default: "" which is the current directory in plugin-node/dist/ which gets destroyed and recreated on every build
101112

102113
# API Keys
103114
ANTHROPIC_API_KEY= # For Claude
115+
SMALL_ANTHROPIC_MODEL= # Default: claude-3-haiku-20240307
116+
MEDIUM_ANTHROPIC_MODEL= # Default: claude-3-5-sonnet-20241022
117+
LARGE_ANTHROPIC_MODEL= # Default: claude-3-5-sonnet-20241022
118+
104119
HEURIST_API_KEY= # Get from https://heurist.ai/dev-access
105120

106121
# Heurist Models

‎.github/workflows/image.yaml

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
#
2+
name: Create and publish a Docker image
3+
4+
# Configures this workflow to run every time a change is pushed to the branch called `release`.
5+
on:
6+
release:
7+
types: [created]
8+
workflow_dispatch:
9+
10+
# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
11+
env:
12+
REGISTRY: ghcr.io
13+
IMAGE_NAME: ${{ github.repository }}
14+
15+
# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
16+
jobs:
17+
build-and-push-image:
18+
runs-on: ubuntu-latest
19+
# Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
20+
permissions:
21+
contents: read
22+
packages: write
23+
attestations: write
24+
id-token: write
25+
#
26+
steps:
27+
- name: Checkout repository
28+
uses: actions/checkout@v4
29+
# Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
30+
- name: Log in to the Container registry
31+
uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
32+
with:
33+
registry: ${{ env.REGISTRY }}
34+
username: ${{ github.actor }}
35+
password: ${{ secrets.GITHUB_TOKEN }}
36+
# This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
37+
- name: Extract metadata (tags, labels) for Docker
38+
id: meta
39+
uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
40+
with:
41+
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
42+
# This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
43+
# It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
44+
# It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
45+
- name: Build and push Docker image
46+
id: push
47+
uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
48+
with:
49+
context: .
50+
push: true
51+
tags: ${{ steps.meta.outputs.tags }}
52+
labels: ${{ steps.meta.outputs.labels }}
53+
54+
# This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)."
55+
- name: Generate artifact attestation
56+
uses: actions/attest-build-provenance@v1
57+
with:
58+
subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
59+
subject-digest: ${{ steps.push.outputs.digest }}
60+
push-to-registry: true
61+

‎.github/workflows/require-develop.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Check pull request source branch
2+
on:
3+
pull_request_target:
4+
types:
5+
- opened
6+
- reopened
7+
- synchronize
8+
- edited
9+
jobs:
10+
check-branches:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Check branches
14+
run: |
15+
if [ ${{ github.head_ref }} != "develop" ] && [ ${{ github.base_ref }} == "main" ]; then
16+
echo "Merge requests to main branch are only allowed from dev branch."
17+
exit 1
18+
fi

‎README.md

+133-133
Original file line numberDiff line numberDiff line change
@@ -1,133 +1,133 @@
1-
# Eliza 🤖
2-
3-
<div align="center">
4-
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
5-
</div>
6-
7-
<div align="center">
8-
9-
📖 [Documentation](https://ai16z.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)
10-
11-
</div>
12-
13-
## 🌍 README Translations
14-
15-
[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md)
16-
17-
## ✨ Features
18-
19-
- 🛠️ Full-featured Discord, Twitter and Telegram connectors
20-
- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
21-
- 👥 Multi-agent and room support
22-
- 📚 Easily ingest and interact with your documents
23-
- 💾 Retrievable memory and document store
24-
- 🚀 Highly extensible - create your own actions and clients
25-
- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
26-
- 📦 Just works!
27-
28-
## 🎯 Use Cases
29-
30-
- 🤖 Chatbots
31-
- 🕵️ Autonomous Agents
32-
- 📈 Business Process Handling
33-
- 🎮 Video Game NPCs
34-
- 🧠 Trading
35-
36-
## 🚀 Quick Start
37-
38-
### Prerequisites
39-
40-
- [Python 2.7+](https://www.python.org/downloads/)
41-
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
42-
- [pnpm](https://pnpm.io/installation)
43-
44-
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
45-
46-
### Use the Starter (Recommended)
47-
48-
```bash
49-
git clone https://github.com/ai16z/eliza-starter.git
50-
51-
cp .env.example .env
52-
53-
pnpm i && pnpm start
54-
```
55-
56-
Then read the [Documentation](https://ai16z.github.io/eliza/) to learn how to customize your Eliza.
57-
58-
### Manually Start Eliza (Only recommended if you know what you are doing)
59-
60-
```bash
61-
# Clone the repository
62-
git clone https://github.com/ai16z/eliza.git
63-
64-
# Checkout the latest release
65-
# This project iterates fast, so we recommend checking out the latest release
66-
git checkout $(git describe --tags --abbrev=0)
67-
```
68-
69-
### Start Eliza with Gitpod
70-
71-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ai16z/eliza/tree/main)
72-
73-
### Edit the .env file
74-
75-
Copy .env.example to .env and fill in the appropriate values.
76-
77-
```
78-
cp .env.example .env
79-
```
80-
81-
Note: .env is optional. If your planning to run multiple distinct agents, you can pass secrets through the character JSON
82-
83-
### Automatically Start Eliza
84-
85-
This will run everything to setup the project and start the bot with the default character.
86-
87-
```bash
88-
sh scripts/start.sh
89-
```
90-
91-
### Edit the character file
92-
93-
1. Open `agent/src/character.ts` to modify the default character. Uncomment and edit.
94-
95-
2. To load custom characters:
96-
- Use `pnpm start --characters="path/to/your/character.json"`
97-
- Multiple character files can be loaded simultaneously
98-
3. Connect with X (Twitter)
99-
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
100-
101-
### Manually Start Eliza
102-
103-
```bash
104-
pnpm i
105-
pnpm build
106-
pnpm start
107-
108-
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
109-
pnpm clean
110-
```
111-
112-
#### Additional Requirements
113-
114-
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
115-
116-
```
117-
pnpm install --include=optional sharp
118-
```
119-
120-
### Community & contact
121-
122-
- [GitHub Issues](https://github.com/ai16z/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
123-
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
124-
125-
## Contributors
126-
127-
<a href="https://github.com/ai16z/eliza/graphs/contributors">
128-
<img src="https://contrib.rocks/image?repo=ai16z/eliza" />
129-
</a>
130-
131-
## Star History
132-
133-
[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)
1+
# Eliza 🤖
2+
3+
<div align="center">
4+
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
5+
</div>
6+
7+
<div align="center">
8+
9+
📖 [Documentation](https://ai16z.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)
10+
11+
</div>
12+
13+
## 🌍 README Translations
14+
15+
[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md)
16+
17+
## ✨ Features
18+
19+
- 🛠️ Full-featured Discord, Twitter and Telegram connectors
20+
- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
21+
- 👥 Multi-agent and room support
22+
- 📚 Easily ingest and interact with your documents
23+
- 💾 Retrievable memory and document store
24+
- 🚀 Highly extensible - create your own actions and clients
25+
- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
26+
- 📦 Just works!
27+
28+
## 🎯 Use Cases
29+
30+
- 🤖 Chatbots
31+
- 🕵️ Autonomous Agents
32+
- 📈 Business Process Handling
33+
- 🎮 Video Game NPCs
34+
- 🧠 Trading
35+
36+
## 🚀 Quick Start
37+
38+
### Prerequisites
39+
40+
- [Python 2.7+](https://www.python.org/downloads/)
41+
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
42+
- [pnpm](https://pnpm.io/installation)
43+
44+
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
45+
46+
### Use the Starter (Recommended)
47+
48+
```bash
49+
git clone https://github.com/ai16z/eliza-starter.git
50+
51+
cp .env.example .env
52+
53+
pnpm i && pnpm start
54+
```
55+
56+
Then read the [Documentation](https://ai16z.github.io/eliza/) to learn how to customize your Eliza.
57+
58+
### Manually Start Eliza (Only recommended if you know what you are doing)
59+
60+
```bash
61+
# Clone the repository
62+
git clone https://github.com/ai16z/eliza.git
63+
64+
# Checkout the latest release
65+
# This project iterates fast, so we recommend checking out the latest release
66+
git checkout $(git describe --tags --abbrev=0)
67+
```
68+
69+
### Start Eliza with Gitpod
70+
71+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ai16z/eliza/tree/main)
72+
73+
### Edit the .env file
74+
75+
Copy .env.example to .env and fill in the appropriate values.
76+
77+
```
78+
cp .env.example .env
79+
```
80+
81+
Note: .env is optional. If your planning to run multiple distinct agents, you can pass secrets through the character JSON
82+
83+
### Automatically Start Eliza
84+
85+
This will run everything to setup the project and start the bot with the default character.
86+
87+
```bash
88+
sh scripts/start.sh
89+
```
90+
91+
### Edit the character file
92+
93+
1. Open `agent/src/character.ts` to modify the default character. Uncomment and edit.
94+
95+
2. To load custom characters:
96+
- Use `pnpm start --characters="path/to/your/character.json"`
97+
- Multiple character files can be loaded simultaneously
98+
3. Connect with X (Twitter)
99+
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
100+
101+
### Manually Start Eliza
102+
103+
```bash
104+
pnpm i
105+
pnpm build
106+
pnpm start
107+
108+
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
109+
pnpm clean
110+
```
111+
112+
#### Additional Requirements
113+
114+
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
115+
116+
```
117+
pnpm install --include=optional sharp
118+
```
119+
120+
### Community & contact
121+
122+
- [GitHub Issues](https://github.com/ai16z/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
123+
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
124+
125+
## Contributors
126+
127+
<a href="https://github.com/ai16z/eliza/graphs/contributors">
128+
<img src="https://contrib.rocks/image?repo=ai16z/eliza" />
129+
</a>
130+
131+
## Star History
132+
133+
[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)

0 commit comments

Comments
 (0)