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

Baptiste Augrain b1970e82af do not start crashReporter when appCenter isn't configured (#787) 4 年之前
.github d29337f328 Fix custom-gallery patch (#758) 4 年之前
build b99e93970e fixing windows 4 年之前
docs 53b071366b Fix AppImage's dependency (#775) 4 年之前
icons 28ccd0bf00 insert final newline 4 年之前
patches b1970e82af do not start crashReporter when appCenter isn't configured (#787) 4 年之前
src b00ffc8610 Fix icons (#734) 4 年之前
.gitignore a8372aa348 macOS Big Sur App icon update. 4 年之前
CODE_OF_CONDUCT.md b40a02dc7f Add code of conduct 6 年之前
DOCS.md 6a5ba92d10 add link to build doc 4 年之前
LICENSE b41635b951 Update the license year to 2021 4 年之前
README.md 2abbfed911 fix typo in README.md (#785) 4 年之前
VSCodium-AppImage-Recipe.yml 98372f9d1e Fixing python in AppImage (#773) 4 年之前
build.sh 7d636ce0f7 build media files used for the preview 4 年之前
check_cron_or_pr.sh 479d4c3dbc fix variable name 4 年之前
check_tags.sh 384789005b specify system setup name properly in check_tags 4 年之前
create_appimage.sh 53b071366b Fix AppImage's dependency (#775) 4 年之前
get_repo.sh 51ee66e019 Add support to build insider latest build: $ INSIDER=1 ./build/build_mac.sh (#784) 4 年之前
prepare_vscode.sh 8187c7fd7f add a loop to apply patches (#779) 4 年之前
sum.sh 52ef4eb7be linux: fix appimage (#731) 4 年之前
undo_telemetry.sh 66551077f8 Add support to use GNU sed installed in mac osx (#770) 4 年之前
update_settings.sh 66551077f8 Add support to use GNU sed installed in mac osx (#770) 4 年之前
update_version.sh 768ea6778e (experiment) use GH actions for Windows builds 4 年之前
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, published by 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

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#49159 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 limitted 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