Skip to content

Commit dbddac5

Browse files
authored
Added windows statup script (#734)
1 parent 00769bd commit dbddac5

File tree

3 files changed

+20
-7
lines changed

3 files changed

+20
-7
lines changed

README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,17 @@ The cli sets up the following for AgentGPT:
4444
- 🤖 [Backend](https://github.com/reworkd/AgentGPT/tree/main/platform) (FastAPI)
4545
- 🎨 [Frontend](https://github.com/reworkd/AgentGPT/tree/main/next) (Nextjs)
4646

47-
To get started follow run the commands below.
47+
- You will need node intalled, you can check by running 'node -v' or install [node](https://nodejs.org/en/download)
48+
49+
To get started on Mac/Linux, run the commands below.
4850
```bash
4951
git clone https://github.com/reworkd/AgentGPT.git && cd AgentGPT
5052
./setup.sh
5153
```
52-
54+
If you are on windows, you can do the following after downloading the repo.
55+
```
56+
setup.bat
57+
```
5358
> 🐳 The recommend way to set up AgentGPT locally is to [docker-compose](https://www.docker.com/), please make sure you have docker installed.
5459
5560
## 🎉 Roadmap

docs/docs/development/setup.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,20 @@ The following document will help you set up a local installation of AgentGPT.
1515
## Interactive Setup
1616

1717
We've recently launched an interactive setup tool that will guide you through creating an ENV and running AgentGPT.
18-
Simply run the following:
18+
19+
- You will need node intalled you can check by running 'node -v' or install [node](https://nodejs.org/en/download)
20+
21+
Simply run the following on a unix system:
1922

2023
```
2124
git clone https://github.com/reworkd/AgentGPT.git && cd AgentGPT
2225
./setup.sh
2326
```
2427

25-
If you are on windows, you can do the following after downloading the repo
28+
If you are on windows, you can do the following after downloading the repo:
2629

2730
```
28-
cd cli
29-
npm install
30-
npm run start
31+
setup.bat
3132
```
3233

3334
Going this route, you can ignore the below text.

setup.bat

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
@echo off
2+
setlocal
3+
4+
rem The CLI will take care of setting up the ENV variables
5+
cd cli || exit /b 1
6+
call npm install
7+
npm run start

0 commit comments

Comments
 (0)