binary releases of VS Code without MS branding/telemetry/licensing
Go to file
Baptiste Augrain 2faafce844 feat(1.86): update patches 2024-02-03 18:19:42 +01:00
.github build(deps): bump peter-evans/repository-dispatch from 2 to 3 (#1794) 2024-01-29 14:05:13 +01:00
build feat: notarize commit id (#1728) 2023-11-15 17:31:04 +01:00
docs docs: fixes typos (#1714) 2023-11-07 19:20:49 +01:00
icons refactor: shell optimizations 2023-07-23 18:35:27 +02:00
patches feat(1.86): update patches 2024-02-03 18:19:42 +01:00
src feat: update to 1.78 (#1500) 2023-05-10 02:30:07 +02:00
stores refactor: passing linter on all bash scripts 2023-07-21 16:45:07 +02:00
.editorconfig fix: update size of letterpress images (#992) 2022-02-06 16:05:53 +01:00
.gitignore fix: remote dependencies (#1324) 2022-11-10 18:18:26 +01:00
.nvmrc feat(1.82): update patches and use node-v18 (#1626) 2023-09-03 14:59:11 +02:00
CODE_OF_CONDUCT.md docs: update `CODE_OF_CONDUCT.md` from v1.4 to v2.1 (#1056) 2022-04-20 06:09:35 +02:00
CONTRIBUTING.md docs: fixes typos (#1714) 2023-11-07 19:20:49 +01:00
LICENSE fix: update license menu (#824) 2021-09-07 12:22:40 +02:00
README.md docs: add vscode link (#1730) 2023-11-16 10:22:09 +01:00
announcements-builtin.json chore: update api and annoucements [skip ci] 2023-03-31 14:54:19 +02:00
announcements-extra.json feat: update to 1.78 (#1500) 2023-05-10 02:30:07 +02:00
build.sh fix: remove npm config [skip ci] 2023-08-04 19:03:41 +02:00
check_cron_or_pr.sh ci: generate assets for a pr [skip ci] 2023-12-17 00:30:20 +01:00
check_tags.sh build: add spearhead checking [skip ci] 2023-11-15 22:41:07 +01:00
get_repo.sh ci: add user/email for merge [skip ci] 2023-12-17 19:41:35 +01:00
insider.json feat: prepare for 1.85 (#1706) 2023-10-31 12:39:06 +01:00
install_gh.sh refactor: passing linter for root bash scripts (#1569) 2023-07-20 20:25:13 +02:00
install_remote_dependencies.sh refactor: passing linter for root bash scripts (#1569) 2023-07-20 20:25:13 +02:00
patch.sh refactor: passing linter for root bash scripts (#1569) 2023-07-20 20:25:13 +02:00
prepare_assets.sh fix: disabling appimage [skip ci] 2023-09-13 09:14:23 +02:00
prepare_src.sh fix: make prepare_src.sh executable [skip ci] 2023-11-15 22:02:08 +01:00
prepare_vscode.sh fix: don't checkout insider for stable [skip ci] 2023-11-15 20:45:18 +01:00
product.json feat(1.86): update patches 2024-02-03 18:19:42 +01:00
release.sh refactor: shell optimizations 2023-07-23 18:35:27 +02:00
stable.json feat(1.86): update patches 2024-02-03 18:19:42 +01:00
undo_telemetry.sh refactor: passing linter for root bash scripts (#1569) 2023-07-20 20:25:13 +02:00
update_qualityjson.sh fix: update commit msg and branch name [skip ci] 2023-12-14 21:11:53 +01:00
update_settings.sh refactor: shell optimizations 2023-07-23 18:35:27 +02:00
update_version.sh refactor: shell optimizations 2023-07-23 18:35:27 +02:00
utils.sh refactor: passing linter on all bash scripts 2023-07-21 16:45:07 +02:00
version.sh refactor: passing linter on all bash scripts 2023-07-21 16:45:07 +02:00

README.md

current release license Gitter codium codium

build status (linux) build status (macos) build status (windows)

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

🎉 🎉 Download latest release here: stable or insiders 🎉 🎉

More info / helpful tips are here.

Install with Brew (Mac)

If you are on a Mac and have Homebrew installed:

# stable
brew install --cask vscodium

# insiders
brew tap homebrew/cask-versions
brew install --cask vscodium-insiders

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:

:: stable
winget install -e --id VSCodium.VSCodium

:: insider
winget install -e --id VSCodium.VSCodium.Insiders

Install with Chocolatey (Windows)

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

:: stable
choco install vscodium

:: insider
choco install vscodium-insiders

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 for stable or insiders, but you can also install using your favorite package manager and get automatic updates.

@paulcarroty has set up a repository with instructions for apt, dnf and zypper 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, maintained by @binex-dsk as package vscodium-bin (stable) and as vscodium-insiders-bin.

If you want to save disk space by having VSCodium use the Electron system-wide, you also have vscodium-electron, maintained by @m00nw4tch3r.

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. Those packages downloaded during build are:

More Info

Documentation

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

Troubleshooting

If you have any issue, please check the Troubleshooting page or the existing issues.

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 10 / Server 2012 R2 or newer x64
  • Windows 10 / Server 2012 R2 or newer x86
  • Windows 10 / Server 2012 R2 or newer arm64

Donate

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

Special thanks to:

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

License

MIT