Skip to content

Commit

Permalink
Added windows statup script (reworkd#734)
Browse files Browse the repository at this point in the history
  • Loading branch information
TylerRLowe authored Jun 7, 2023
1 parent 00769bd commit dbddac5
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 6 additions & 5 deletions docs/docs/development/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 7 additions & 0 deletions setup.bat
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit dbddac5

Please sign in to comment.