binary releases of VS Code without MS branding/telemetry/licensing

Levi Zim f8462bb0a4 fix(riscv): lower glibc version to 2.31 for ripgrep (#2376) 1 周之前
.github bd3f4701ad feat(1.100): update patches (#2360) 3 周之前
build f8462bb0a4 fix(riscv): lower glibc version to 2.31 for ripgrep (#2376) 1 周之前
dev bd3f4701ad feat(1.100): update patches (#2360) 3 周之前
docs 7ef31896fd docs: typo 2 周之前
icons bc47aeedce feat: rebrand reh-web resources (#2314) 1 月之前
patches bd3f4701ad feat(1.100): update patches (#2360) 3 周之前
src bc47aeedce feat: rebrand reh-web resources (#2314) 1 月之前
stores efd176d43d fix(snap): sort with number map instead of string (#2373) 2 周之前
upstream 0fdce0c326 build(stable): update to commit 848b80a 2 周之前
.editorconfig b319b178ea fix: update size of letterpress images (#992) 3 年之前
.gitignore eb7d54bd62 build(linux): build snap with core20 [skip ci] 1 年之前
.nvmrc bd3f4701ad feat(1.100): update patches (#2360) 3 周之前
CODE_OF_CONDUCT.md bff2e71e55 docs: update `CODE_OF_CONDUCT.md` from v1.4 to v2.1 (#1056) 3 年之前
CONTRIBUTING.md c9976ec085 feat: remove yarn dependency (#2297) 1 月之前
FUNDING.json f309a13e49 chore: add drips funding [skip ci] 1 年之前
LICENSE 5439ac0757 fix: update license menu (#824) 3 年之前
README.md 02812dccdf docs: split and improve 3 周之前
announcements-builtin.json f985c78aaa chore: update api and annoucements [skip ci] 2 年之前
announcements-extra.json 670a5ae8a6 docs: add new announcement 2 周之前
build.sh 6c5a8eb3fb feat: cli binary (#2313) 1 月之前
build_cli.sh f47684a94c fix(ci): add variables to only ci [skip ci] 1 月之前
check_cron_or_pr.sh 3b86373e7c ci(linux): regroup checks [skip ci] 1 年之前
check_tags.sh bd3f4701ad feat(1.100): update patches (#2360) 3 周之前
get_pr.sh 3047fd50fb fix: add git workaround [skip ci] 7 月之前
get_repo.sh 7eb89b4189 fix: add/remove leading 0 when needed 1 月之前
install_gh.sh 292d2783db ci: use jq to get gh cli (#2168) 4 月之前
npmrc b9975ba5d2 feat(1.98): update patches (#2244) 2 月之前
prepare_assets.sh bd3f4701ad feat(1.100): update patches (#2360) 3 周之前
prepare_checksums.sh a6cd884c37 build(windows): calculate checksums after signing [skip ci] 7 月之前
prepare_src.sh 8606615423 fix: make prepare_src.sh executable [skip ci] 1 年之前
prepare_vscode.sh 6c5a8eb3fb feat: cli binary (#2313) 1 月之前
product.json bd3f4701ad feat(1.100): update patches (#2360) 3 周之前
release.sh bd3f4701ad feat(1.100): update patches (#2360) 3 周之前
release_notes.md bd3f4701ad feat(1.100): update patches (#2360) 3 周之前
undo_telemetry.sh b4318d78a0 refactor: passing linter for root bash scripts (#1569) 1 年之前
update_settings.sh 79baded01d refactor: shell optimizations 1 年之前
update_upstream.sh 89b4e9a712 fix: upload only notary files [skip ci] 2 月之前
update_version.sh bbc892183f fix: publish version for all archs (#2315) 1 月之前
utils.sh bd3f4701ad feat(1.100): update patches (#2360) 3 周之前
version.sh 1c0c30e6d6 refactor: passing linter on all bash scripts 1 年之前

README.md

[![current release](https://img.shields.io/github/release/vscodium/vscodium.svg)](https://github.com/vscodium/vscodium/releases) [![license](https://img.shields.io/github/license/VSCodium/vscodium.svg)](https://github.com/VSCodium/vscodium/blob/master/LICENSE) [![Gitter](https://img.shields.io/gitter/room/vscodium/vscodium.svg)](https://gitter.im/VSCodium/Lobby) [![codium](https://snapcraft.io//codium/badge.svg)](https://snapcraft.io/codium) [![codium](https://snapcraft.io//codium/trending.svg?name=0)](https://snapcraft.io/codium) [![build status (linux)](https://img.shields.io/github/actions/workflow/status/VSCodium/vscodium/stable-linux.yml?branch=master&label=build%28linux%29)](https://github.com/VSCodium/vscodium/actions/workflows/stable-linux.yml?query=branch%3Amaster) [![build status (macos)](https://img.shields.io/github/actions/workflow/status/VSCodium/vscodium/stable-macos.yml?branch=master&label=build%28macOS%29)](https://github.com/VSCodium/vscodium/actions/workflows/stable-macos.yml?query=branch%3Amaster) [![build status (windows)](https://img.shields.io/github/actions/workflow/status/VSCodium/vscodium/stable-windows.yml?branch=master&label=build%28windows%29)](https://github.com/VSCodium/vscodium/actions/workflows/stable-windows.yml?query=branch%3Amaster)

This is not a fork. This is a repository of scripts to automatically build Microsoft's vscode repository into freely-licensed binaries with a community-driven default configuration.

Table of Contents

Download/Install

:tada: :tada: Download latest release here: stable or insiders :tada: :tada:

More info / helpful tips are here.

Install with Brew (Mac)

If you are on a Mac and have Homebrew installed:

# stable
brew install --cask vscodium

# insiders
brew install --cask vscodium@insiders

Note for macOS users: if you can't open the App, please read the following troubleshooting.

Install with Windows Package Manager (WinGet)

If you use Windows and have Windows Package Manager installed:

:: stable
winget install -e --id VSCodium.VSCodium

:: insider
winget install -e --id VSCodium.VSCodium.Insiders

Install with Chocolatey (Windows)

If you use Windows and have Chocolatey installed (thanks to @Thilas):

:: stable
choco install vscodium

:: insider
choco install vscodium-insiders

Install with Scoop (Windows)

If you use Windows and have Scoop installed:

scoop bucket add extras
scoop install vscodium

Install with snap (GNU/Linux)

VSCodium is available in the Snap Store as Codium, thanks to the help of the Snapcrafters community. If your GNU/Linux distribution has support for snaps:

snap install codium --classic

Install with Package Manager (GNU/Linux)

You can always install using the downloads (deb, rpm, tar) on the releases page for stable or insiders, but you can also install using your favorite package manager and get automatic updates.

@paulcarroty has set up a repository with instructions for apt, dnf and zypper here.

Any issues installing VSCodium using your package manager should be directed to that repository's issue tracker.

Install on Arch Linux

VSCodium is available in AUR, maintained by @binex-dsk as package vscodium-bin (stable) and as vscodium-insiders-bin.

If you want to save disk space by having VSCodium use the Electron system-wide, you also have vscodium-electron, maintained by @m00nw4tch3r.

An alternative package vscodium-git, maintained by @cedricroijakkers, is also available should you wish to compile from source yourself.

Flatpak Option (GNU/Linux)

VSCodium is available as a Flatpak app here and the build repo is here. If your distribution has support for flatpak, and you have enabled the flathub repo:

flatpak install flathub com.vscodium.codium
flatpak run com.vscodium.codium

Build

Build instructions can be found here

Why Does This Exist

This repository contains build files to generate free release binaries of Microsoft's Visual Studio Code. When we speak of "free software", we're talking about freedom, not price.

Microsoft's releases of Visual Studio Code are licensed under this not-FLOSS license and contain telemetry/tracking. According to this comment from a Visual Studio Code maintainer:

When we [Microsoft] build Visual Studio Code, we do exactly this. We clone the vscode repository, we lay down a customized product.json that has Microsoft specific functionality (telemetry, gallery, logo, etc.), and then produce a build that we release under our license.

When you clone and build from the vscode repo, none of these endpoints are configured in the default product.json. Therefore, you generate a "clean" build, without the Microsoft customizations, which is by default licensed under the MIT license

This repo exists so that you don't have to download+build from source. The build scripts in this repo clone Microsoft's vscode repo, run the build commands, and upload the resulting binaries to GitHub releases. These binaries are licensed under the MIT license. Telemetry is disabled.

If you want to build from source yourself, head over to Microsoft's vscode repo and follow their instructions. This repo exists to make it easier to get the latest version of MIT-licensed Visual Studio Code.

Microsoft's build process (which we are running to build the binaries) does download additional files. Those packages downloaded during build are:

More Info

Documentation

For more information on getting all the telemetry disabled, tips for migrating from Visual Studio Code to VSCodium and more, have a look at the Docs page page.

Troubleshooting

If you have any issue, please check the Troubleshooting page or the existing issues.

Extensions and the Marketplace

According to the Visual Studio Marketplace Terms of Use, you may only install and use Marketplace Offerings with Visual Studio Products and Services. For this reason, VSCodium uses open-vsx.org, an open source registry for Visual Studio Code extensions. See the Extensions + Marketplace section on the Docs page for more details.

Please note that some Visual Studio Code extensions have licenses that restrict their use to the official Visual Studio Code builds and therefore do not work with VSCodium. See this note on the Docs page for what's been found so far and possible workarounds.

How are the VSCodium binaries built?

If you would like to see the commands we run to build vscode into VSCodium binaries, have a look at the workflow files in .github/workflows for Windows, GNU/Linux and macOS. These build files call all the other scripts in the repo. If you find something that doesn't make sense, feel free to ask about it on Gitter.

The builds are run every day, but exit early if there isn't a new release from Microsoft.

Supported Platforms

The minimal version is limited by the core component Electron, you may want to check its platform prerequisites.

  • macOS (zip, dmg) macOS 10.15 or newer x64
  • macOS (zip, dmg) macOS 11.0 or newer arm64
  • GNU/Linux x64 (deb, rpm, AppImage, snap, tar.gz)
  • GNU/Linux arm64 (deb, rpm, snap, tar.gz)
  • GNU/Linux armhf (deb, rpm, tar.gz)
  • GNU/Linux riscv64 (tar.gz)
  • GNU/Linux loong64 (tar.gz)
  • GNU/Linux ppc64le (tar.gz)
  • Windows 10 / Server 2012 R2 or newer x64
  • Windows 10 / Server 2012 R2 or newer arm64

Special thanks

@jaredreich for the logo
@PalinuroSec for CDN and domain name
MacStadium logo for providing a Mac mini M1
@daiyam for macOS certificate
SignPath logo free code signing on Windows provided by SignPath.io, certificate by SignPath Foundation

License

MIT