Skip to content

Commit

Permalink
Update README.MD
Browse files Browse the repository at this point in the history
  • Loading branch information
@Autocop-Agent
Autocop-Agent authored May 29, 2023
1 parent cd79b18 commit 8fec5e6
Showing 1 changed file with 15 additions and 54 deletions.
69 changes: 15 additions & 54 deletions README.MD
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@

</p>

### 💡 Features
<hr>

## 💡 Features

- Provision, Spawn & Deploy Autonomous AI Agents
- Extend Agent Capabilities with Tools
Expand All @@ -71,7 +73,7 @@
- Concurrent Agents
- Resource Manager

### 💻 Screenshots
## 💻 Screenshots
**CLI View**
![CLI](https://superagi.co/wp-content/uploads/2023/05/CLI.png)

Expand All @@ -87,19 +89,15 @@
</p>


### 🛣 Roadmap
## 🛣 Roadmap
[Click here to checkout the latest roadmap 🔗](https://github.com/users/TransformerOptimus/projects/1)


### ⚙️ Setting up
**YOU NEED PINECONE SETUP FOR THIS**
1. Download the repo using `git clone https://github.com/TransformerOptimus/SuperAGI.git` in your terminal or directly from github page in zip format and unzip in your desired folder
2. Navigate to the directory using `cd SuperAGI`
3. Find the file named `config_template.yaml` and create a copy of `config_template.yaml` and name it `config.yaml`; if you want to do it in terminal window use: `cp config_template.yaml config.yaml` (use `copy` command for windows)

4. Open the `config.yaml` file in a text editor.
5. Find the line that says `OPENAI_API_KEY`:
6. After the `:` in the respective variable assignment, enter your unique OpenAI API Key, Google key, Custom search engine ID, and Pinecone API key without any quotes or spaces. Follow the links below to get your keys:
## ⚙️ Setting up
**YOU NEED DOCKER AND PINECONE SETUP**
1. Download the repo using `git clone https://github.com/TransformerOptimus/SuperAGI.git` in your terminal or directly from github page in zip format.
2. Navigate to the directory using `cd SuperAGI` and create a copy of `config_template.yaml` and name it `config.yaml`.
3. Enter your unique OpenAI API Key, Google key, Custom search engine ID, and Pinecone API key without any quotes or spaces in `config.yaml` file. Follow the links below to get your keys:

|Keys|Accessing the keys|
|--|--|
Expand All @@ -110,54 +108,17 @@

>If you're on the Pinecone free plan, you only have 1 pod and 1 index available. As a workaround, change the index name used in test.py where `memory` is defined: `memory = VectorFactory.get_vector_storage("PineCone", "my-current-indexname", OpenAiEmbedding())`
7. Save and close the `config.yaml` file


## 🛠Setup Docker

### Windows
1. Download the appropriate Docker Desktop version for your system: [Docker for Windows](https://docs.docker.com/docker-for-windows/install/).
2. Run the `Docker Desktop Installer.exe` file, it should install Docker on your system.
> If wsl is not installed in your system, Download the [Linux Kernel Update Package](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi) and set wsl 2 as your default version by typing `wsl --set-default-version 2` into your Windows Powershell.
3. Ensure that Docker Desktop is running.
4. Check if you are SuperAGI directory in Windows Powershell. If not, use `cd` command to navigate to the SuperAGI directory
5. Run command : `docker-compose up`
6. Once your server is live, just open any browser and go to `localhost:3000`

### Mac
1. Download the appropriate Docker Desktop version for your system: [Docker for Mac](https://docs.docker.com/docker-for-mac/install/).
2. Run the `Docker.dmg` file to install docker, it should install Docker on your system.
3. Once it is installed, ensure that Docker Desktop is running.
4. Check if you are SuperAGI directory in terminal. If not, use `cd` command to navigate to the SuperAGI directory
5. Run command : `docker-compose up`
6. Once your server is live, just open any browser and go to `localhost:3000`

### Linux
1. Download the appropriate Docker Desktop version for your system: [Docker for Linux](https://docs.docker.com/desktop/install/linux-install/)
2. Follow the steps according to your specific OS: ([Ubuntu](https://docs.docker.com/desktop/install/ubuntu/), [Debian](https://docs.docker.com/desktop/install/debian/), [Fedora](https://docs.docker.com/desktop/install/fedora/))
3. Once Docker is installed, ensure that Docker Desktop is running.
4. Check if you are SuperAGI directory in terminal. If not, use `cd` command to navigate to the SuperAGI directory
5. Run command : `docker-compose up`
6. Once your server is live, just open any browser and go to `localhost:3000`


# 🏃‍♂️ Running SuperAGI
Simply run the start script in your terminal. This will install any necessary Python packages and launch SuperAGI

* On Linux/MacOS:
`source run.sh`
* On Windows:
`.\run.bat`
> If this gives errors, make sure you have a compatible Python version installed (preferrably python 3.10).
4. Ensure that Docker is installed in your system, if not, Install it from [here](https://docs.docker.com/get-docker/).
5. Once you have Docker Desktop running, run command : `docker-compose up`. Open browser and go to `localhost:3000` to run SuperAGI.

# ⚠️ Under Development!
## ⚠️ Under Development!
This project is under active development and may still have issues. We appreciate your understanding and patience. If you encounter any problems, please first check the open issues. If your issue is not listed, kindly create a new issue detailing the error or problem you experienced. Thank you for your support!


# 👩‍💻Contributors
## 👩‍💻Contributors
[![TransformerOptimus](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/133493246?v=4&w=50&h=50&mask=circle)](https://github.com/TransformerOptimus) [![Cptsnowcrasher](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/133322218?v=4&w=50&h=50&mask=circle)](https://github.com/Cptsnowcrasher) [![vectorcrow](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/133646556?v=4&w=50&h=50&mask=circle)](https://github.com/vectorcrow) [![Akki-jain](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/92881074?v=4&w=50&h=50&mask=circle)](https://github.com/Akki-jain) [![Autocop-Agent](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/129729746?v=4&w=50&h=50&mask=circle)](https://github.com/Autocop-Agent)[![COLONAYUSH](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/60507126?v=4&w=50&h=50&mask=circle)](https://github.com/COLONAYUSH)[![luciferlinx101](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/129729795?v=4&w=50&h=50&mask=circle)](https://github.com/luciferlinx101)[![mukundans89](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/101278493?v=4&w=50&h=50&mask=circle)](https://github.com/mukundans89)[![Fluder-Paradyne](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/121793617?v=4&w=50&h=50&mask=circle)](https://github.com/Fluder-Paradyne)[![nborthy](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/101320057?v=4&w=50&h=50&mask=circle)](https://github.com/nborthy)[![nihirr](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/122777244?v=4&w=50&h=50&mask=circle)](https://github.com/nihirr)[![Tarraann](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/97586318?v=4&w=50&h=50&mask=circle)](https://github.com/Tarraann)[![Fluder-Paradyne](https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/121793617?v=4&w=50&h=50&mask=circle)](https://github.com/Fluder-Paradyne)


# ⭐Star History
## ⭐Star History

[![Star History Chart](https://api.star-history.com/svg?repos=TransformerOptimus/SuperAGI&type=Date)](https://star-history.com/#TransformerOptimus/SuperAGI&Date)

0 comments on commit 8fec5e6

Please sign in to comment.