Skip to content

Commit c93111d

Browse files
committed
docs: Update Quick Start to use prebuilt Docker images
1 parent 2b16c12 commit c93111d

1 file changed

Lines changed: 12 additions & 16 deletions

File tree

README.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A secure, open-source code interpreter API that provides sandboxed code executio
88

99
## Quick Start
1010

11-
Get up and running in minutes.
11+
Get up and running in minutes using prebuilt Docker images.
1212

1313
1. **Clone the repository**
1414

@@ -21,32 +21,28 @@ Get up and running in minutes.
2121

2222
```bash
2323
cp .env.example .env
24-
# The default settings in .env work out-of-the-box for local development
24+
# The default settings work out-of-the-box for local development
2525
```
2626

27-
3. **Build Execution Environments**
28-
29-
The API requires language-specific execution images.
30-
31-
**Minimal Setup (Python only):**
27+
3. **Pull execution environment images**
3228

3329
```bash
34-
cd docker && ./build-images.sh -l python && cd ..
35-
```
36-
37-
**Full Suite (All 12 Languages):**
30+
# Python only (minimal)
31+
docker pull ghcr.io/usnavy13/librecodeinterpreter/python:latest
3832

39-
```bash
40-
cd docker && ./build-images.sh -p && cd ..
33+
# Or pull all 12 languages
34+
for lang in python nodejs go java c-cpp php rust r fortran d; do
35+
docker pull ghcr.io/usnavy13/librecodeinterpreter/$lang:latest
36+
done
4137
```
4238

43-
> **Note:** The `-p` flag enables parallel builds, which significantly reduces build time for the full suite.
44-
4539
4. **Start the API**
4640
```bash
47-
docker compose up -d --build
41+
docker compose up -d
4842
```
4943

44+
> **Building from source?** See the [Development Guide](docs/DEVELOPMENT.md) for instructions on building images locally.
45+
5046
The API will be available at `http://localhost:8000`.
5147
Visit `http://localhost:8000/docs` for the interactive API documentation.
5248

0 commit comments

Comments
 (0)