Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Evo Ninja instructions to Readme and Docs #6495

Closed
wants to merge 7 commits into from
Closed

Add Evo Ninja instructions to Readme and Docs #6495

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cd2698e
Update README.md with evo start up instructions
rihp Dec 4, 2023
7f612fe
Update README.md
rihp Dec 4, 2023
37ba71d
Update docs index.md
rihp Dec 4, 2023
77c5484
Update index.md
rihp Dec 4, 2023
ae9baca
requested changes
rihp Dec 5, 2023
b6a2da3
remove duplication of info
rihp Dec 5, 2023
cf1e20b
remove duplication of info
rihp Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,24 @@ The AutoGPT Arena Hackathon saw [**evo.ninja**](https://github.com/polywrap/evo.

📈 To challenge evo.ninja, AutoGPT, and others, submit your benchmark run to the [Leaderboard](#-leaderboard), and maybe your agent will be up here next!


### How to Run Evo Ninja
To run Evo Ninja, follow these detailed steps:
1. **Pre-Requisites**: Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), [nodejs](https://nodejs.org/en/download/package-manager#alpine-linux), [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable), and [nvm](https://github.com/nvm-sh/nvm#installing-and-updating).
2. **Installation**:
- Clone the repository: `git clone https://github.com/polywrap/evo.ninja`
rihp marked this conversation as resolved.
Show resolved Hide resolved
- Copy and rename the environment template: `cp .env.template .env`
rihp marked this conversation as resolved.
Show resolved Hide resolved
- Add your OpenAI API Key to `.env`: `OPENAI_API_KEY=your_key_here`
- Add your SERP API Key to `.env`: `SERP_API_KEY=your_key_here`
- Use the correct Node.JS version: `nvm install && nvm use`
- Install dependencies and build: `yarn && yarn build`
3. Run the agent: `yarn start`
4. Prompt the agent and watch it do its magic!

For detailed instructions, visit the [evo.ninja documentation](https://github.com/polywrap/evo.ninja#readme), and for live support, join the [evo.ninja discord](https://discord.com/invite/r3rwh69cCa)
rihp marked this conversation as resolved.
Show resolved Hide resolved



## 🧱 Building blocks

### 🏗️ Forge
Expand Down
23 changes: 22 additions & 1 deletion docs/content/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,28 @@ To tie these together, we also have a [CLI] at the root of the project.

---

## 🤖 Agent
## 🥇 Best Agent: evo.ninja

evo.ninja emerged as a top-performing agent in the recent AutoGPT Arena hackathon, establishing itself as a best open-source generalist agent. You can explore its capabilities at https://evo.ninja.

### Setting Up and Running Evo Ninja
To get started with Evo Ninja, follow these comprehensive steps:
1. **Initial Setup Requirements**: Make sure to install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), [nodejs](https://nodejs.org/en/download/package-manager#alpine-linux), [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable), and [nvm](https://github.com/nvm-sh/nvm#installing-and-updating).
2. **Installation Process**:
- Clone the evo.ninja repository: `git clone https://github.com/polywrap/evo.ninja`
- Rename the `.env.template` file to `.env`: `cp .env.template .env`
- Add your OpenAI API Key in the `.env` file: `OPENAI_API_KEY=your_key_here`
- Include your SERP API Key in the same file: `SERP_API_KEY=your_key_here`
- Switch to the appropriate Node.JS version: `nvm install && nvm use`
- Install dependencies and build the project: `yarn && yarn build`
3. Start the agent: `yarn start`
4. Interact with the agent to see it in action!

For a detailed guide, visit the [evo.ninja documentation](https://github.com/polywrap/evo.ninja#readme). For additional support and community interaction, join the [evo.ninja Discord](https://discord.com/invite/r3rwh69cCa).

---

## 🤖 AutoGPT Agent

**[📖 About AutoGPT](AutoGPT/index.md)**
 | 
Expand Down