opencode

(โ˜… 199,829)

The open source coding agent.

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

  • .dockerignore
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .gitleaksignore
  • .oxlintrc.json
  • .prettierignore
  • AGENTS.md
  • bun.lock
  • bunfig.toml
  • CONTEXT.md
  • CONTRIBUTING.md
  • flake.lock
  • flake.nix
  • install
  • LICENSE
  • package.json
  • README.ar.md
  • README.bn.md
  • README.br.md
  • README.bs.md
  • README.da.md
  • README.de.md
  • README.es.md
  • README.fr.md
  • README.gr.md
  • README.it.md
  • README.ja.md
  • README.ko.md
  • README.md
  • README.no.md
  • README.pl.md
  • README.ru.md
  • README.th.md
  • README.tr.md
  • README.uk.md
  • README.vi.md
  • README.zh.md
  • README.zht.md
  • SECURITY.md
  • STATS.md

# Installation Guide

1. Get the code
git clone https://github.com/anomalyco/opencode

Downloads the entire project code from GitHub to your computer.

cd opencode

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
  • Scoop A package manager for Windows.
  • Chocolatey A package manager for Windows.
curl -fsSL https://opencode.ai/install | bash

Downloads and runs the official install script in one line โ€” this handles the full setup automatically.

npm i -g opencode-ai@latest # or bun/pnpm/yarn

Installs the package published on the npm registry globally โ€” no need to clone the source.

scoop install opencode # Windows

Installs directly via Scoop (Windows).

choco install opencode # Windows

Installs directly via Chocolatey (Windows).

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
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.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f packages/containers/base/Dockerfile -t opencode .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 opencode

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.

4. 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.
npm i -g opencode-ai@latest # or bun/pnpm/yarn

Installs the package published on the npm registry globally โ€” no need to clone the source.

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

Pulled directly from this repo's README.

// repository documentation