workerd

(β˜… 8,618)

The JavaScript / Wasm runtime that powers Cloudflare Workers

Showing a partial file list β€” download the zip above to see everything.

  • .bazelignore
  • .bazelrc
  • .bazelversion
  • .clang-format
  • .clang-tidy
  • .git-blame-ignore-revs
  • .gitignore
  • .gitlab-ci.yml
  • .npmrc
  • .prettierignore
  • .prettierrc.json
  • AGENTS.md
  • build-releases.sh
  • BUILD.bazel
  • cfsetup.yaml
  • CODE_OF_CONDUCT.md
  • codecov.yml
  • compile_flags.txt
  • CONTRIBUTING.md
  • Dockerfile.release
  • doxyfile
  • justfile
  • LICENSE
  • MODULE.bazel
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • RELEASE.md
  • ruff.toml
  • SECURITY.md

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/cloudflare/workerd

Downloads the entire project code from GitHub to your computer.

cd workerd

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f Dockerfile.release -t workerd .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 workerd

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd images/container-client-test

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r build/deps/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

5. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cd deps/rust

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd src/pyodide/internal/sphinx

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation