diff --git a/README.md b/README.md index 3a35bf6241c..df2bcc00187 100644 --- a/README.md +++ b/README.md @@ -61,33 +61,21 @@ cp .env.example .env pnpm i && pnpm build && pnpm start ``` -Once the agent is running, you should see the message to run "pnpm start:client" at the end. -Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent. - -```bash -pnpm start:client -``` - -Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza. - ### Manually Start Eliza (Only recommended if you know what you are doing) +#### Checkout the latest release + ```bash # Clone the repository git clone https://github.com/elizaos/eliza.git -# Checkout the latest release # This project iterates fast, so we recommend checking out the latest release git checkout $(git describe --tags --abbrev=0) # If the above doesn't checkout the latest release, this should work: # git checkout $(git describe --tags `git rev-list --tags --max-count=1`) ``` -### Start Eliza with Gitpod - -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main) - -### Edit the .env file +#### Edit the .env file Copy .env.example to .env and fill in the appropriate values. @@ -97,6 +85,32 @@ cp .env.example .env Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON + +#### Start Eliza + +```bash +pnpm i +pnpm build +pnpm start + +# The project iterates fast, sometimes you need to clean the project if you are coming back to the project +pnpm clean +``` + +### Interact via Browser + +``` +Once the agent is running, you should see the message to run "pnpm start:client" at the end. +Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent. + +```bash +pnpm start:client +``` + +Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza. + +---- + ### Automatically Start Eliza The start script provides an automated way to set up and run Eliza: @@ -109,7 +123,9 @@ For detailed instructions on using the start script, including character managem > **Note**: The start script handles all dependencies, environment setup, and character management automatically. -### Edit the character file +---- + +### Modify Character 1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit. @@ -119,16 +135,7 @@ For detailed instructions on using the start script, including character managem 3. Connect with X (Twitter) - change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X -### Manually Start Eliza - -```bash -pnpm i -pnpm build -pnpm start - -# The project iterates fast, sometimes you need to clean the project if you are coming back to the project -pnpm clean -``` +--- #### Additional Requirements @@ -137,6 +144,14 @@ You may need to install Sharp. If you see an error when starting up, try install ``` pnpm install --include=optional sharp ``` +--- + + +### Start Eliza with Gitpod + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main) + +--- ### Community & contact