Skip to content

Commit

Permalink
Merge pull request elizaOS#976 from yodamaster726/chat-doc
Browse files Browse the repository at this point in the history
chore: add how to startup chat ui
  • Loading branch information
odilitime authored Dec 11, 2024
2 parents c3f8487 + 8a5c1a5 commit 2864f1c
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 3 deletions.
16 changes: 16 additions & 0 deletions docs/docs/guides/local-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,22 @@ pnpm run test:watch # Run tests in watch mode
pnpm run lint # Lint code
```

### Direct Client Chat UI

```
# Open a terminal and Start with specific character
pnpm run dev --characters="characters/my-character.json"
```
```
# Open a 2nd terminal and start the client
pnpm start:client
```

Look for the message:
` ➜ Local: http://localhost:5173/`
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.


## Database Development

### SQLite (Recommended for Development)
Expand Down
18 changes: 16 additions & 2 deletions docs/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ sidebar_position: 2
## Prerequisites

Before getting started with Eliza, ensure you have:

- [Python 2.7+](https://www.python.org/downloads/)
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [pnpm 9+](https://pnpm.io/installation)
- Git for version control
Expand Down Expand Up @@ -125,6 +123,22 @@ You set which model to use inside the character JSON file
pnpm start --characters="characters/trump.character.json,characters/tate.character.json"
```

3. **Interact with the Agent**

Now you're ready to start a conversation with your agent!
Open a new terminal window

```bash
pnpm start:client
```

Once the client is running, you'll see a message like this:
```
➜ Local: http://localhost:5173/
```

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.

## Platform Integration

### Discord Bot Setup
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"build": "turbo run build --filter=!eliza-docs",
"build-docker": "turbo run build",
"start": "pnpm --filter \"@ai16z/agent\" start --isRoot",
"start:client": "pnpm --dir client start --isRoot",
"start:client": "pnpm --dir client dev",
"start:debug": "cross-env NODE_ENV=development VERBOSE=true DEBUG=eliza:* pnpm --filter \"@ai16z/agent\" start --isRoot",
"dev": "bash ./scripts/dev.sh",
"lint": "bash ./scripts/lint.sh",
Expand Down

0 comments on commit 2864f1c

Please sign in to comment.