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

Frazer Smith 3737c9f4e2 build: Use `cd ... || exit` in case `cd` fails (#1107) 3 yıl önce
.github 90bc38c840 vcs: fix lock workflow config (#1113) 3 yıl önce
build 3737c9f4e2 build: Use `cd ... || exit` in case `cd` fails (#1107) 3 yıl önce
docs c2469ff520 fix: re-enable 32bits builds with `npm_config_force_process_config` env variable (#1082) 3 yıl önce
icons 98d30bdc2c build: double quote args and wrap in brace expansions (#1105) 3 yıl önce
patches 0932463dfb fix(1.67): update patches (#1066) 3 yıl önce
src 843ef66728 fix: letterpress icons names (#1042) 3 yıl önce
stores add78d6829 build(stores/snapcraft): quote grep pattern so shell won't interpret it (#1108) 3 yıl önce
.editorconfig b319b178ea fix: update size of letterpress images (#992) 3 yıl önce
.gitignore 84b4396476 feat: add support for reh (#1111) 3 yıl önce
.nvmrc 966ae12699 build: use node v16 (#1054) 3 yıl önce
CODE_OF_CONDUCT.md bff2e71e55 docs: update `CODE_OF_CONDUCT.md` from v1.4 to v2.1 (#1056) 3 yıl önce
DOCS.md 6a86200d38 docs: how to fix default file manager on linux (#983) 3 yıl önce
LICENSE 5439ac0757 fix: update license menu (#824) 3 yıl önce
README.md c53a88ee51 docs: improve macOS troubleshooting and add thanks table (#1083) 3 yıl önce
build.sh 3737c9f4e2 build: Use `cd ... || exit` in case `cd` fails (#1107) 3 yıl önce
check_cron_or_pr.sh 98d30bdc2c build: double quote args and wrap in brace expansions (#1105) 3 yıl önce
check_tags.sh 84b4396476 feat: add support for reh (#1111) 3 yıl önce
get_repo.sh 3737c9f4e2 build: Use `cd ... || exit` in case `cd` fails (#1107) 3 yıl önce
install_gh.sh e564685c1e feat: selective publish (#858) 3 yıl önce
prepare_artifacts.sh 84b4396476 feat: add support for reh (#1111) 3 yıl önce
prepare_vscode.sh 3737c9f4e2 build: Use `cd ... || exit` in case `cd` fails (#1107) 3 yıl önce
product.json db8d1e7a8d fix: add missing extensionEnabledApiProposals and more (#1040) 3 yıl önce
release.sh 98d30bdc2c build: double quote args and wrap in brace expansions (#1105) 3 yıl önce
undo_telemetry.sh 98d30bdc2c build: double quote args and wrap in brace expansions (#1105) 3 yıl önce
update_settings.sh 98d30bdc2c build: double quote args and wrap in brace expansions (#1105) 3 yıl önce
update_version.sh e564685c1e feat: selective publish (#858) 3 yıl önce
utils.sh 98d30bdc2c build: double quote args and wrap in brace expansions (#1105) 3 yıl önce

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 supported platform list.

  • 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