Skip to content

Commit a11dd5a

Browse files
shakkernerdshakkernerd
authored
Merge pull request elizaOS#2229 from HowieDuhzit/main
Merge my Eliza Installer with the current start.sh script
2 parents d5a56c9 + a993a8c commit a11dd5a

File tree

4 files changed

+891
-54
lines changed

4 files changed

+891
-54
lines changed

‎README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,16 @@ Note: .env is optional. If you're planning to run multiple distinct agents, you
100100

101101
### Automatically Start Eliza
102102

103-
This will run everything to set up the project and start the bot with the default character.
103+
The start script provides an automated way to set up and run Eliza:
104104

105105
```bash
106106
sh scripts/start.sh
107107
```
108108

109+
For detailed instructions on using the start script, including character management and troubleshooting, see our [Start Script Guide](./docs/docs/guides/start-script.md).
110+
111+
> **Note**: The start script handles all dependencies, environment setup, and character management automatically.
112+
109113
### Edit the character file
110114

111115
1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.

‎docs/docs/guides/start-script.md

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
# 🤖 Eliza Start Script
2+
3+
> A powerful, cross-platform launcher for your AI companion
4+
5+
## 🚀 Quick Start
6+
7+
```bash
8+
# Linux/macOS from eliza root directory
9+
./scripts/start.sh
10+
```
11+
12+
## 💻 System Requirements
13+
14+
<details>
15+
<summary><b>🐧 Linux</b></summary>
16+
17+
- Bash shell
18+
- `sudo` access
19+
- APT package manager
20+
- 2GB free disk space
21+
</details>
22+
23+
<details>
24+
<summary><b>🍎 macOS</b></summary>
25+
26+
- macOS 10.15 or higher
27+
- Command Line Tools
28+
- Admin access
29+
- 2GB free disk space
30+
</details>
31+
32+
<details>
33+
<summary><b>🪟 Windows (WSL2)</b></summary>
34+
35+
**Requirements:**
36+
- Windows 10 version 2004+ or Windows 11
37+
- 8GB RAM minimum
38+
- Virtualization enabled in BIOS
39+
- Admin access to install WSL2
40+
41+
**Installation Steps:**
42+
1. Enable WSL2:
43+
```powershell
44+
# Run in PowerShell as Administrator
45+
wsl --install
46+
```
47+
48+
2. Install Ubuntu from Microsoft Store or:
49+
```powershell
50+
wsl --install -d Ubuntu
51+
```
52+
53+
3. Restart your computer
54+
55+
4. Set up Ubuntu:
56+
- Open Ubuntu from Start Menu
57+
- Create username and password when prompted
58+
- Run updates:
59+
```bash
60+
sudo apt update && sudo apt upgrade -y
61+
```
62+
63+
Now you can follow the Linux instructions!
64+
</details>
65+
66+
## ✨ Features
67+
68+
| Feature | Description |
69+
|---------|-------------|
70+
| 🔍 OS Detection | Automatically adapts to your platform |
71+
| 🛠️ Zero Config | Installs all dependencies automatically |
72+
| 📦 Node.js | Manages versions and packages seamlessly |
73+
| 🎭 Characters | Full character management interface |
74+
| 🔄 Updates | One-click updates and version management |
75+
| ⚙️ Environment | Guided configuration setup |
76+
77+
## 🎮 Usage
78+
79+
### Command Line Options
80+
```bash
81+
start.sh [-v|--verbose] [--skip-nvm]
82+
```
83+
84+
| Option | Description |
85+
|--------|-------------|
86+
| `-v, --verbose` | Show detailed progress |
87+
| `--skip-nvm` | Use system Node.js |
88+
### 🔄 Starting and Updating Eliza
89+
90+
| Action | Description |
91+
|--------|-------------|
92+
| Start | Launch current version |
93+
| Update | Install latest updates |
94+
| Reinstall | Fresh installation |
95+
96+
### 🎭 Character Management
97+
98+
<details>
99+
<summary><b>Creating New Characters</b></summary>
100+
101+
1. Select `Create New`
102+
2. Enter character name
103+
3. Customize in editor
104+
4. Save & deploy
105+
</details>
106+
107+
<details>
108+
<summary><b>Using Existing Characters</b></summary>
109+
110+
1. Select `Use Existing`
111+
2. Choose characters:
112+
- Select each: `X`
113+
- Select All: `Ctrl+A`
114+
- Confirm: `ENTER`
115+
</details>
116+
117+
<details>
118+
<summary><b>Character Actions</b></summary>
119+
120+
**Single Character:**
121+
- ▶️ Run
122+
- ✏️ Edit
123+
- 🗑️ Delete
124+
125+
**Multiple Characters:**
126+
- ▶️ Run All
127+
- 🗑️ Delete All
128+
</details>
129+
130+
### ⚙️ Configuration
131+
132+
133+
134+
## 🛟 Troubleshooting
135+
136+
### Common Solutions
137+
138+
<details>
139+
<summary><b>🔒 Permission Issues</b></summary>
140+
141+
```bash
142+
# Linux/macOS
143+
sudo chmod +x scripts/start.sh
144+
145+
# Windows
146+
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
147+
```
148+
</details>
149+
150+
<details>
151+
<summary><b>📦 Node.js Issues</b></summary>
152+
153+
- Required: Node.js 22+
154+
- Use `--skip-nvm` for system Node
155+
- Check PATH configuration
156+
</details>
157+
158+
<details>
159+
<summary><b>🔧 Package Manager Issues</b></summary>
160+
161+
- Linux: `sudo apt update`
162+
- macOS: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
163+
- Windows: Run as Administrator
164+
</details>
165+
166+
### 🚨 Common Errors
167+
168+
169+
| `characters not found` | Check working directory |
170+
171+
## 📝 Notes
172+
173+
- Temporary files: `/tmp/eliza_*`
174+
- Config location: `./config`
175+
- Characters: `./characters/*.json`
176+
177+
## 🆘 Support
178+
179+
Need help? Try these steps:
180+
181+
1. Run with verbose logging:
182+
```bash
183+
./scripts/start.sh -v
184+
```
185+
2. Check console output
186+
3. [Open an issue](https://github.com/elizaOS/eliza/issues)
187+
188+
---
189+
<div align="center">
190+
<i>Made with ❤️ by the ai16z team</i>
191+
</div>

‎pnpm-lock.yaml

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)