diff --git a/README.md b/README.md index 5a94af1d09..580fab9e69 100755 --- a/README.md +++ b/README.md @@ -44,12 +44,17 @@ The cli sets up the following for AgentGPT: - 🤖 [Backend](https://github.com/reworkd/AgentGPT/tree/main/platform) (FastAPI) - 🎨 [Frontend](https://github.com/reworkd/AgentGPT/tree/main/next) (Nextjs) -To get started follow run the commands below. +- You will need node intalled, you can check by running 'node -v' or install [node](https://nodejs.org/en/download) + +To get started on Mac/Linux, run the commands below. ```bash git clone https://github.com/reworkd/AgentGPT.git && cd AgentGPT ./setup.sh ``` - +If you are on windows, you can do the following after downloading the repo. +``` +setup.bat +``` > 🐳 The recommend way to set up AgentGPT locally is to [docker-compose](https://www.docker.com/), please make sure you have docker installed. ## 🎉 Roadmap diff --git a/docs/docs/development/setup.md b/docs/docs/development/setup.md index af0ca61e22..78406f13c4 100644 --- a/docs/docs/development/setup.md +++ b/docs/docs/development/setup.md @@ -15,19 +15,20 @@ The following document will help you set up a local installation of AgentGPT. ## Interactive Setup We've recently launched an interactive setup tool that will guide you through creating an ENV and running AgentGPT. -Simply run the following: + +- You will need node intalled you can check by running 'node -v' or install [node](https://nodejs.org/en/download) + +Simply run the following on a unix system: ``` git clone https://github.com/reworkd/AgentGPT.git && cd AgentGPT ./setup.sh ``` -If you are on windows, you can do the following after downloading the repo +If you are on windows, you can do the following after downloading the repo: ``` -cd cli -npm install -npm run start +setup.bat ``` Going this route, you can ignore the below text. diff --git a/setup.bat b/setup.bat new file mode 100644 index 0000000000..00c52aa27b --- /dev/null +++ b/setup.bat @@ -0,0 +1,7 @@ +@echo off +setlocal + +rem The CLI will take care of setting up the ENV variables +cd cli || exit /b 1 +call npm install +npm run start