You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
formatting, break up copy/paste so easier to run one by one, improve accuracy of character section and how to start it, Add clarify and additional info to common issues
Copy file name to clipboardexpand all lines: docs/docs/quickstart.md
+80-51
Original file line number
Diff line number
Diff line change
@@ -18,80 +18,95 @@ Before getting started with Eliza, ensure you have:
18
18
19
19
1.**Clone and Install**
20
20
21
-
Please be sure to check what the [latest available stable version tag](https://github.com/ai16z/eliza/tags) is.
21
+
Please be sure to check what the [latest available stable version tag](https://github.com/ai16z/eliza/tags) is.
22
22
23
-
```bash
24
-
# Clone the repository
25
-
git clone https://github.com/ai16z/eliza.git
26
-
# Enter directory
27
-
cd eliza
28
-
# Switch to tagged release
29
-
git checkout v0.0.10
30
-
31
-
# Install dependencies
32
-
pnpm install
33
-
```
23
+
Clone the repository
24
+
```bash
25
+
git clone https://github.com/ai16z/eliza.git
26
+
```
27
+
28
+
Enter directory
29
+
```bash
30
+
cd eliza
31
+
```
32
+
33
+
Switch to latest tagged release
34
+
```bash
35
+
git checkout v0.0.10
36
+
```
37
+
38
+
Install dependencies
39
+
```bash
40
+
pnpm install
41
+
```
34
42
35
43
2.**Configure Environment**
36
44
37
-
```bash
38
-
# Copy example environment file
39
-
cp .env.example .env
40
-
```
45
+
Copy example environment file
46
+
```bash
47
+
cp .env.example .env
48
+
```
41
49
42
-
Edit `.env` and add your values:
50
+
Edit `.env` and add your values:
43
51
44
-
```bash
45
-
# Required environment variables
46
-
DISCORD_APPLICATION_ID= # For Discord integration
47
-
DISCORD_API_TOKEN= # Bot token
48
-
OPENAI_API_KEY= # OpenAI API key (starting with sk-*)
49
-
ELEVENLABS_XI_API_KEY= # API key from elevenlabs (for voice)
50
-
```
52
+
```bash
53
+
# Suggested quickstart environment variables
54
+
DISCORD_APPLICATION_ID= # For Discord integration
55
+
DISCORD_API_TOKEN= # Bot token
56
+
OPENAI_API_KEY= # OpenAI API key (starting with sk-*)
57
+
ELEVENLABS_XI_API_KEY= # API key from elevenlabs (for voice)
58
+
```
51
59
52
60
## Choose Your Model
53
61
54
-
Eliza supports multiple AI models:
62
+
Eliza supports multiple AI models:
55
63
56
-
-**Llama**: Set `XAI_MODEL=meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo`
57
-
-**Grok**: Set `XAI_MODEL=grok-beta`
58
-
-**OpenAI**: Set `XAI_MODEL=gpt-4o-mini` or `gpt-4o`
64
+
-**Llama**: Set `XAI_MODEL=meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo`
65
+
-**Grok**: Set `XAI_MODEL=grok-beta`
66
+
-**OpenAI**: Set `XAI_MODEL=gpt-4o-mini` or `gpt-4o`
59
67
60
-
You set which model to use inside the character JSON file
68
+
You set which model to use inside the character JSON file
61
69
62
-
### Local inference
70
+
### Local inference
63
71
64
-
#### For llama_local inference:
72
+
#### For llama_local inference:
65
73
66
-
1. Set `XAI_MODEL` to your chosen model
67
-
2. Leave `X_SERVER_URL` and `XAI_API_KEY` blank
68
-
3. The system will automatically download the model from Hugging Face
69
-
4.`LOCAL_LLAMA_PROVIDER` can be blank
74
+
1. Set `XAI_MODEL` to your chosen model
75
+
2. Leave `X_SERVER_URL` and `XAI_API_KEY` blank
76
+
3. The system will automatically download the model from Hugging Face
77
+
4. `LOCAL_LLAMA_PROVIDER` can be blank
70
78
71
-
Note: llama_local requires a GPU, it currently will not work with CPU inference
79
+
Note: llama_local requires a GPU, it currently will not work with CPU inference
72
80
73
-
#### For Ollama inference:
81
+
#### For Ollama inference:
74
82
75
-
- If `OLLAMA_SERVER_URL` is left blank, it defaults to `localhost:11434`
76
-
- If `OLLAMA_EMBEDDING_MODE` is left blank, it defaults to `mxbai-embed-large`
83
+
- If `OLLAMA_SERVER_URL` is left blank, it defaults to `localhost:11434`
84
+
- If `OLLAMA_EMBEDDING_MODE` is left blank, it defaults to `mxbai-embed-large`
77
85
78
86
## Create Your First Agent
79
87
80
88
1.**Create a Character File**
89
+
81
90
Check out `characters/trump.character.json` or `characters/tate.character.json` as a template you can use to copy and customize your agent's personality and behavior.
82
-
Additionally you can read `packages/core/src/defaultCharacter.ts`
91
+
Additionally you can read `core/src/core/defaultCharacter.ts` (in 0.0.10 but post-refactor will be in `packages/core/src/defaultCharacter.ts`)
0 commit comments