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

Peter Squicciarini fabacf1c1a Merge pull request #347 from NebojsaKrtolica/patch-1 5 years ago
.github ac42eadd68 Update issue templates 6 years ago
patches 98a9a1b231 Fix update cache path 5 years ago
src ccb2ee47b3 Add update information to AppImage 5 years ago
.gitignore 098cab67bd Windows builds with Azure Pipelines (#58) 6 years ago
.travis.yml 8347fbcdc8 Merge pull request #335 from stripedpajamas/node_12 5 years ago
CODE_OF_CONDUCT.md b40a02dc7f Add code of conduct 6 years ago
DOCS.md 5dd8c0e6da :scroll: portable mode description 5 years ago
LICENSE 83847916ca Testing build 6 years ago
README.md 08d8ad26ab Add armhf support 5 years ago
VSCodium-AppImage-Recipe.yml 75bbad9a0d Bugfix AppImage 5 years ago
azure-pipelines.yml f9f92ce008 Build cleanup and Windows ia32 (#103) 6 years ago
build.sh a3465c0f1b Use Node 12 and frozen lockfile 5 years ago
check_tags.ps1 f9f92ce008 Build cleanup and Windows ia32 (#103) 6 years ago
check_tags.sh c440844e99 Update check_tags.sh 5 years ago
create_appimage.sh 31b80c8c09 Modified AppImage build method (#294) 5 years ago
create_dmg.sh 1c6cb799c8 Add execute permissions to create_dmg.sh 6 years ago
create_zip.sh 08d8ad26ab Add armhf support 5 years ago
get_repo.sh a5b2066f76 Commit version JSON after deploy (#158) 6 years ago
install_deps.sh 08d8ad26ab Add armhf support 5 years ago
sign_mac_app.sh 0608a0e812 Sign mac app (#136) 6 years ago
sum.sh 818097ca7e Add hacky, initial arm64 support 5 years ago
undo_telemetry.sh f805d740bb Undo telemetry before build (#27) 6 years ago
update_settings.sh d203723bd5 Update path to crash reporter setting 5 years ago
update_version.sh 72781d2f52 Add update support for Win32 system install 6 years ago
win32-build.yml a3465c0f1b Use Node 12 and frozen lockfile 5 years ago

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) [![build status](https://travis-ci.com/VSCodium/vscodium.svg?branch=master)](https://travis-ci.com/VSCodium/vscodium) [![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)

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 cask install vscodium

Note for Mac OS X 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 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 Package Manager (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 @plague-doctor.

Flatpak Option (Linux)

VSCodium is not available as a Flatpak app, but @amtlib-dot-dll has done significant work to package up the open source build of Visual Studio Code without telemetry, very similarly to VSCodium. That package is available here and the build repo is here.

Why Does This Exist

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

Microsoft's downloads 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 VSCode.

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.

Extension Licensing

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 .travis.yml file (for Linux and OS X builds) and the win32-build.yml file (for Windows builds). 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. To examine the build logs, go here for Linux / OS X and here for Windows

Supported OS

  • OS X (zip, dmg)
  • Linux x64 (deb, rpm, AppImage, tar.gz)
  • Linux x86 (deb, rpm, tar.gz) (up to v1.35.1)
  • Linux arm64 (deb, tar.gz)
  • Linux armhf (deb, tar.gz)
  • Windows x64
  • Windows x86

Donate

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

License

MIT