You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,10 +67,21 @@ docker run -it \
67
67
ghcr.io/opendevin/opendevin
68
68
```
69
69
70
+
> [!NOTE]
71
+
> By default, this command pulls the `latest` tag, which represents the most recent release of OpenDevin. You have other options as well:
72
+
> - For a specific release version, use `ghcr.io/opendevin/opendevin:<OpenDevin_version>` (replace <OpenDevin_version> with the desired version number).
73
+
> - For the most up-to-date development version, use `ghcr.io/opendevin/opendevin:main`. This version may be **(unstable!)** and is recommended for testing or development purposes only.
74
+
>
75
+
> Choose the tag that best suits your needs based on stability requirements and desired features.
76
+
70
77
You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000) with access to `./workspace`. To have OpenDevin operate on your code, place it in `./workspace`.
71
78
72
79
OpenDevin will only have access to this workspace folder. The rest of your system will not be affected as it runs in a secured docker sandbox.
73
80
81
+
For the development workflow, see [Development.md](https://github.com/OpenDevin/OpenDevin/blob/main/Development.md).
82
+
83
+
Are you having trouble? Check out our [Troubleshooting Guide](https://opendevin.github.io/OpenDevin/modules/usage/troubleshooting).
84
+
74
85
## 🚀 Documentation
75
86
76
87
To learn more about the project, and for tips on using OpenDevin,
Copy file name to clipboardExpand all lines: docs/modules/usage/intro.mdx
+1-44Lines changed: 1 addition & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,50 +57,7 @@ Explore the codebase of OpenDevin on [GitHub](https://github.com/OpenDevin/OpenD
57
57
:::
58
58
59
59
## 🛠️ Getting Started
60
-
61
-
The easiest way to run OpenDevin is inside a Docker container. It works best with the most recent version of Docker, `26.0.0`.
62
-
You must be using Linux, Mac OS, or WSL on Windows.
63
-
64
-
To start OpenDevin in a docker container, run the following commands in your terminal:
65
-
66
-
:::warning
67
-
When you run the following command, files in `./workspace` may be modified or deleted.
68
-
:::
69
-
70
-
```bash
71
-
WORKSPACE_BASE=$(pwd)/workspace
72
-
docker run -it \
73
-
--pull=always \
74
-
-e SANDBOX_USER_ID=$(id -u) \
75
-
-e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
76
-
-v $WORKSPACE_BASE:/opt/workspace_base \
77
-
-v /var/run/docker.sock:/var/run/docker.sock \
78
-
-p 3000:3000 \
79
-
--add-host host.docker.internal:host-gateway \
80
-
--name opendevin-app-$(date +%Y%m%d%H%M%S) \
81
-
ghcr.io/opendevin/opendevin
82
-
```
83
-
84
-
:::note
85
-
By default, this command pulls the `latest` tag, which represents the most recent release of OpenDevin. You have other options as well:
86
-
87
-
- For a specific release version, use `ghcr.io/opendevin/opendevin:OpenDevin_version` (replace OpenDevin_version with the desired version number).
88
-
- For the most up-to-date development version, use `ghcr.io/opendevin/opendevin:main`. This version may be **(unstable!)** and is recommended for testing or development purposes only.
89
-
90
-
Choose the tag that best suits your needs based on stability requirements and desired features.
91
-
:::
92
-
93
-
You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000) with access to `./workspace`. To have OpenDevin operate on your code, place it in `./workspace`.
94
-
95
-
OpenDevin will only have access to this workspace folder. The rest of your system will not be affected as it runs in a secured docker sandbox.
96
-
97
-
For the development workflow, see [Development.md](https://github.com/OpenDevin/OpenDevin/blob/main/Development.md).
98
-
99
-
Are you having trouble? Check out our [Troubleshooting Guide](https://opendevin.github.io/OpenDevin/modules/usage/troubleshooting).
100
-
101
-
:::warning
102
-
OpenDevin is currently a work in progress, but you can already run the alpha version to see the end-to-end system in action.
103
-
:::
60
+
[Check out the getting started guide on Github](https://github.com/OpenDevin/OpenDevin?tab=readme-ov-file#-getting-started)
0 commit comments