vscodium

[current release] [license] [Gitter] [codium] [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
  • Install with Brew
  • Install with Windows Package Manager (WinGet)
  • Install with Chocolatey
  • Install with Scoop
  • Install with snap
  • Install with Package Manager
  • Install on Arch Linux
  • Flatpak Option
• Build
• Why Does This Exist
• More Info
• Supported Platforms
• Previously Supported Platforms

Download/Install

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

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

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 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 Visual Studio 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 Visual Studio Code.

Microsoft's build process (which we are running to build the binaries) does download additional files. Those packages downloaded during build are:

• Pre-built extensions from the GitHub:
  • ms-vscode.js-debug-companion
  • ms-vscode.js-debug
  • ms-vscode.vscode-js-profile-table
• From Electron releases (using gulp-atom-electron)
  • electron
  • ffmpeg

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 Visual Studio 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 Visual Studio 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) macOS 12 or newer x64
• macOS (zip, dmg) macOS 12 or newer arm64
• GNU/Linux x64 (deb, rpm, AppImage, snap, tar.gz)
• GNU/Linux arm64 (deb, rpm, snap, tar.gz)
• GNU/Linux riscv64 (tar.gz)
• GNU/Linux loong64 (tar.gz)
• GNU/Linux ppc64le (tar.gz)
• Windows 10 / Server 2012 R2 or newer x64
• Windows 10 / Server 2012 R2 or newer arm64

Previously Supported Platforms

• Windows 32bits:
  • Latest available: v1.83.1.23285.

Special thanks

License

MIT