Skip to content

Commit 2864f1c

Browse files
authored
Merge pull request #976 from yodamaster726/chat-doc
chore: add how to startup chat ui
2 parents c3f8487 + 8a5c1a5 commit 2864f1c

File tree

3 files changed

+33
-3
lines changed

3 files changed

+33
-3
lines changed

docs/docs/guides/local-development.md

+16
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,22 @@ pnpm run test:watch # Run tests in watch mode
9494
pnpm run lint # Lint code
9595
```
9696

97+
### Direct Client Chat UI
98+
99+
```
100+
# Open a terminal and Start with specific character
101+
pnpm run dev --characters="characters/my-character.json"
102+
```
103+
```
104+
# Open a 2nd terminal and start the client
105+
pnpm start:client
106+
```
107+
108+
Look for the message:
109+
` ➜ Local: http://localhost:5173/`
110+
Click on that link or open a browser window to that location. Once you do that you should see the chat interface connect with the system and you can start interacting with your character.
111+
112+
97113
## Database Development
98114

99115
### SQLite (Recommended for Development)

docs/docs/quickstart.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ sidebar_position: 2
77
## Prerequisites
88

99
Before getting started with Eliza, ensure you have:
10-
11-
- [Python 2.7+](https://www.python.org/downloads/)
1210
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
1311
- [pnpm 9+](https://pnpm.io/installation)
1412
- Git for version control
@@ -125,6 +123,22 @@ You set which model to use inside the character JSON file
125123
pnpm start --characters="characters/trump.character.json,characters/tate.character.json"
126124
```
127125

126+
3. **Interact with the Agent**
127+
128+
Now you're ready to start a conversation with your agent!
129+
Open a new terminal window
130+
131+
```bash
132+
pnpm start:client
133+
```
134+
135+
Once the client is running, you'll see a message like this:
136+
```
137+
➜ Local: http://localhost:5173/
138+
```
139+
140+
Simply click the link or open your browser to `http://localhost:5173/`. You'll see the chat interface connect to the system, and you can begin interacting with your character.
141+
128142
## Platform Integration
129143

130144
### Discord Bot Setup

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"build": "turbo run build --filter=!eliza-docs",
66
"build-docker": "turbo run build",
77
"start": "pnpm --filter \"@ai16z/agent\" start --isRoot",
8-
"start:client": "pnpm --dir client start --isRoot",
8+
"start:client": "pnpm --dir client dev",
99
"start:debug": "cross-env NODE_ENV=development VERBOSE=true DEBUG=eliza:* pnpm --filter \"@ai16z/agent\" start --isRoot",
1010
"dev": "bash ./scripts/dev.sh",
1111
"lint": "bash ./scripts/lint.sh",

0 commit comments

Comments
 (0)