Skip to content

Commit cde29a9

Browse files
committed
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
1 parent b6cdbdf commit cde29a9

File tree

1 file changed

+80
-51
lines changed

1 file changed

+80
-51
lines changed

docs/docs/quickstart.md

+80-51
Original file line numberDiff line numberDiff line change
@@ -18,80 +18,95 @@ Before getting started with Eliza, ensure you have:
1818

1919
1. **Clone and Install**
2020

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.
2222

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+
```
3442

3543
2. **Configure Environment**
3644

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+
```
4149

42-
Edit `.env` and add your values:
50+
Edit `.env` and add your values:
4351

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+
```
5159

5260
## Choose Your Model
5361

54-
Eliza supports multiple AI models:
62+
Eliza supports multiple AI models:
5563

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`
5967

60-
You set which model to use inside the character JSON file
68+
You set which model to use inside the character JSON file
6169

62-
### Local inference
70+
### Local inference
6371

64-
#### For llama_local inference:
72+
#### For llama_local inference:
6573

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
7078

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
7280

73-
#### For Ollama inference:
81+
#### For Ollama inference:
7482

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`
7785

7886
## Create Your First Agent
7987

8088
1. **Create a Character File**
89+
8190
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`)
8392

84-
You can also load a specific characters only:
93+
📝 [Character Documentation](./core/characterfile.md)
8594

86-
```bash
87-
pnpm start --character="characters/trump.character.json"
88-
```
8995

9096
2. **Start the Agent**
9197

92-
```bash
93-
pnpm start
94-
```
98+
Inform it which character you want to run:
99+
100+
```bash
101+
pnpm start --character="characters/trump.character.json"
102+
```
103+
104+
You can also load multiple characters with the characters option with a comma separated list:
105+
106+
```bash
107+
pnpm start --characters="characters/trump.character.json,characters/tate.character.json"
108+
```
109+
95110

96111
## Platform Integration
97112

@@ -164,15 +179,17 @@ pnpm start --characters="characters/trump.character.json,characters/tate.charact
164179

165180
3. **CUDA Setup**
166181
- Verify CUDA Toolkit installation
167-
- Check GPU compatibility
182+
- Check GPU compatibility with toolkit
168183
- Ensure proper environment variables are set
169184

170185
4. **Exit Status 1**
171186
If you see
172187
```
173-
ERR_PNPM_RECURSIVE_RUN_FIRST_FAIL @ai16z/agent@0.0.1 start: node --loader ts-node/esm src/index.ts "--isRoot"
174-
Exit status 1
175-
ELIFECYCLE Command failed with exit code 1.
188+
triggerUncaughtException(
189+
^
190+
[Object: null prototype] {
191+
[Symbol(nodejs.util.inspect.custom)]: [Function: [nodejs.util.inspect.custom]]
192+
}
176193
```
177194

178195
You can try these steps, which aim to add `@types/node` to various parts of the project
@@ -215,6 +232,18 @@ pnpm start --characters="characters/trump.character.json,characters/tate.charact
215232
pnpm rebuild better-sqlite3
216233
```
217234

235+
If that doesn't work, try clearing your node_modules in the root folder
236+
237+
```bash
238+
rm -fr node_modules; rm pnpm-lock.yaml
239+
```
240+
241+
Then reinstall the requirements
242+
243+
```bash
244+
pnpm i
245+
```
246+
218247
## Next Steps
219248

220249
Once you have your agent running, explore:

0 commit comments

Comments
 (0)