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

Baptiste Augrain 1cbc6e55bf enhance: move variables outside loop (#1002) 3 年之前
.github 23152cf50f fix(snap): review snap only when needed (#959) 3 年之前
build 2dab7cfcdf fix(1.64): update patch (#988) 3 年之前
docs 1ef601a79b sync build dependencies with MS VSC docs 3 年之前
icons 108166f640 build: add MSI (#827) 3 年之前
patches 2dab7cfcdf fix(1.64): update patch (#988) 3 年之前
src b319b178ea fix: update size of letterpress images (#992) 3 年之前
stores bbcdc2be11 fix(snap): add missing icons and add review before publish (#957) 3 年之前
.editorconfig b319b178ea fix: update size of letterpress images (#992) 3 年之前
.gitignore 353c002605 fix(appimage): remove extraneous libs (#944) 3 年之前
CODE_OF_CONDUCT.md b40a02dc7f Add code of conduct 6 年之前
DOCS.md 6a86200d38 docs: how to fix default file manager on linux (#983) 3 年之前
LICENSE 5439ac0757 fix: update license menu (#824) 3 年之前
README.md c803059121 docs: update built-in package names (#982) 3 年之前
build.sh 38810539a7 fix(1.62): fix patches (#899) 3 年之前
check_cron_or_pr.sh 72363757b3 build: push event are detected to avoid premature deployment (#808) 3 年之前
check_tags.sh 02cc193086 fix: check of armhf's rpm is corrected (#860) 3 年之前
get_repo.sh d164e43b78 fix(1.63): update patch (#937) 3 年之前
install_gh.sh e564685c1e feat: selective publish (#858) 3 年之前
prepare_artifacts.sh e564685c1e feat: selective publish (#858) 3 年之前
prepare_vscode.sh 108166f640 build: add MSI (#827) 3 年之前
release.sh 1cbc6e55bf enhance: move variables outside loop (#1002) 3 年之前
undo_telemetry.sh 66551077f8 Add support to use GNU sed installed in mac osx (#770) 4 年之前
update_settings.sh b0ff3b4f34 re-disable telemetry; closes #872 (#883) 3 年之前
update_version.sh e564685c1e feat: selective publish (#858) 3 年之前
utils.sh 66551077f8 Add support to use GNU sed installed in mac osx (#770) 4 年之前

README.md

[![current release](https://img.shields.io/github/release/vscodium/vscodium.svg)](https://github.com/vscodium/vscodium/releases) [![windows_build_status](https://dev.azure.com/vscodium/VSCodium/_apis/build/status/VSCodium.vscodium?branchName=master)](https://dev.azure.com/vscodium/VSCodium/_build?definitionId=1) [![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)

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 Mac macOS Mojave users: if you see "App can't be opened because Apple cannot check it for malicious software" when opening VSCodium the first time, you can right-click the application and choose Open. This should only be required the first time opening on Mojave.

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 via x64 emulation, see status issue
  • 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:

License

MIT