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

Baptiste Augrain 70e6f66c60 feat: build insider from saved commit or from the latest 2 years ago
.github 7a2a3a7ab0 ci: disable insider and reh on windows arm64 3 years ago
build 70e6f66c60 feat: build insider from saved commit or from the latest 2 years ago
docs bfdaf23c6d build(linux): use vscode's ripgrep (#1205) 3 years ago
icons 98d30bdc2c build: double quote args and wrap in brace expansions (#1105) 3 years ago
patches 41d477decd feat: update to support insider version 3 years ago
src 843ef66728 fix: letterpress icons names (#1042) 3 years ago
stores c4583ad3f0 fix: use env variable instead of `login` option (#1128) 3 years ago
.editorconfig b319b178ea fix: update size of letterpress images (#992) 3 years ago
.gitignore 81d304fa37 fix: split version for vscode (#1202) 3 years ago
.nvmrc 966ae12699 build: use node v16 (#1054) 3 years ago
CODE_OF_CONDUCT.md bff2e71e55 docs: update `CODE_OF_CONDUCT.md` from v1.4 to v2.1 (#1056) 3 years ago
DOCS.md 81836873af docs: update legality of vscode marketplace's usage (#1092) 3 years ago
LICENSE 5439ac0757 fix: update license menu (#824) 3 years ago
README.md fdc6b32d8b close #1160 3 years ago
build.sh 85126f1a7c fix: set the built files at the built time (#1132) 3 years ago
check_cron_or_pr.sh 118ea7993d feat: add release number (#1192) 3 years ago
check_tags.sh 7a2a3a7ab0 ci: disable insider and reh on windows arm64 3 years ago
get_repo.sh 70e6f66c60 feat: build insider from saved commit or from the latest 2 years ago
insider.json 70e6f66c60 feat: build insider from saved commit or from the latest 2 years ago
install_gh.sh e564685c1e feat: selective publish (#858) 3 years ago
patch.sh a4e5b2a101 fix: update issue reporter (#1206) 3 years ago
prepare_artifacts.sh 81d304fa37 fix: split version for vscode (#1202) 3 years ago
prepare_vscode.sh 41d477decd feat: update to support insider version 3 years ago
product.json f05272f2d0 fix: update api proposals (#1187) 3 years ago
release.sh 118ea7993d feat: add release number (#1192) 3 years ago
undo_telemetry.sh bfdaf23c6d build(linux): use vscode's ripgrep (#1205) 3 years ago
update_settings.sh 118ea7993d feat: add release number (#1192) 3 years ago
update_version.sh 118ea7993d feat: add release number (#1192) 3 years ago
utils.sh f21c11dde0 fix: install checksum only when needed (#1213) 3 years ago
version.sh f21c11dde0 fix: install checksum only when needed (#1213) 3 years ago

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/workflow/status/VSCodium/vscodium/linux_build/master?label=build%28linux%29)](https://github.com/VSCodium/vscodium/actions/workflows/linux.yml?query=branch%3Amaster) [![build status (macos)](https://img.shields.io/github/workflow/status/VSCodium/vscodium/macos_build/master?label=build%28macos%29)](https://github.com/VSCodium/vscodium/actions/workflows/macos.yml?query=branch%3Amaster) [![build status (windows)](https://img.shields.io/github/workflow/status/VSCodium/vscodium/windows_build/master?label=build%28windows%29)](https://github.com/VSCodium/vscodium/actions/workflows/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 :tada: :tada:

More info / helpful tips are here.

Install with Brew (Mac)

If you are on a Mac and have Homebrew installed:

brew install --cask vscodium

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:

winget install vscodium

Install with Chocolatey (Windows)

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

choco install vscodium

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, but you can also install using your favorite package manager and get automatic updates. @paulcarroty has set up a repository with instructions 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 as package vscodium-bin, maintained by @binex-dsk. 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 (unofficially) 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 VS 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 VS Code.

Microsoft's build process (which we are running to build the binaries) does download additional files. This was brought up in Microsoft/vscode#141340 and Microsoft/vscode#45978. These are the packages downloaded during build:

More Info

Documentation

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

Extensions and the Marketplace

According to the VS Code 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 VS 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) OS X 10.10 or newer x64
  • macOS (zip, dmg) macOS 11.0 or newer arm64
  • GNU/Linux x64 (deb, rpm, AppImage, tar.gz)
  • GNU/Linux x86 (deb, rpm, tar.gz) (up to v1.35.1)
  • GNU/Linux arm64 (deb, tar.gz)
  • GNU/Linux armhf (deb, tar.gz)
  • Windows 7 or newer x64
  • Windows 7 or newer x86
  • Windows 10 arm64

Donate

If you would like to support the development of VSCodium, feel free to send BTC to 3PgjE95yzBDTrSPxPiqoxSgZFuKPPAix1N.

Special thanks to:

@estatra for the latest logo
@jaredreich for the previous logo
@PalinuroSec for CDN and domain name
MacStadium logo for providing a Mac mini M1

License

MIT