Pārlūkot izejas kodu

change default to CodeActAgent and update instructions (#1523)

* change default to CodeActAgent and update instructions

* add quickstart

* change code

* unpin patch version

* Apply suggestions from code review
Robert Brennan 1 gadu atpakaļ
vecāks
revīzija
730fcd7a39
2 mainītis faili ar 25 papildinājumiem un 6 dzēšanām
  1. 22 0
      README.md
  2. 3 6
      docs/src/components/Code/Code.tsx

+ 22 - 0
README.md

@@ -47,6 +47,28 @@ To learn more and to use OpenDevin, check out our [documentation](https://opende
     </a>
 </p>
 
+## ⚡ Quick Start
+You can run OpenDevin with Docker. It works best with the most recent
+version of Docker, `26.0.0`.
+
+```bash
+#The directory you want OpenDevin to modify. MUST be an absolute path!
+export WORKSPACE_BASE=$(pwd)/workspace`;
+
+docker run \
+    --pull=always \
+    -e SANDBOX_USER_ID=$(id -u) \
+    -e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
+    -v $WORKSPACE_BASE:/opt/workspace_base \
+    -v /var/run/docker.sock:/var/run/docker.sock \
+    -p 3000:3000 \
+    --add-host host.docker.internal=host-gateway \
+    ghcr.io/opendevin/opendevin:0.5
+```
+
+For troubleshooting and advanced configuration, see
+[the full documentation](https://opendevin.github.io/OpenDevin/).
+
 ## 🤝 How to Contribute
 
 OpenDevin is a community-driven project, and we welcome contributions from everyone. Whether you're a developer, a researcher, or simply enthusiastic about advancing the field of software engineering with AI, there are many ways to get involved:

+ 3 - 6
docs/src/components/Code/Code.tsx

@@ -4,20 +4,18 @@ import { CodeBlock } from "./CodeBlock";
 import styles from "./styles.module.css";
 
 export function Code() {
-  const keyCode = `# Your OpenAI API key, or any other LLM API key
-export LLM_API_KEY="sk-..."`;
-
   const workspaceCode = `# The directory you want OpenDevin to modify. MUST be an absolute path!
 export WORKSPACE_BASE=$(pwd)/workspace`;
 
   const dockerCode = `docker run \\
-    -e LLM_API_KEY \\
+    --pull=always \\
+    -e SANDBOX_USER_ID=$(id -u) \\
     -e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \\
     -v $WORKSPACE_BASE:/opt/workspace_base \\
     -v /var/run/docker.sock:/var/run/docker.sock \\
     -p 3000:3000 \\
     --add-host host.docker.internal=host-gateway \\
-    ghcr.io/opendevin/opendevin:0.3.1`;
+    ghcr.io/opendevin/opendevin:0.5`;
 
   return (
     <div className={styles.container}>
@@ -38,7 +36,6 @@ export WORKSPACE_BASE=$(pwd)/workspace`;
           </div>
         </div>
         <br />
-        <CodeBlock language="python" code={keyCode} />
         <CodeBlock language="python" code={workspaceCode} />
         <CodeBlock language="python" code={dockerCode} />
       </div>