[![current release](https://img.shields.io/github/release/vscodium/vscodium.svg)](https://github.com/vscodium/vscodium/releases) [![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) [![build status (linux)](https://img.shields.io/github/actions/workflow/status/VSCodium/vscodium/stable-linux.yml?branch=master&label=build%28linux%29)](https://github.com/VSCodium/vscodium/actions/workflows/stable-linux.yml?query=branch%3Amaster) [![build status (macos)](https://img.shields.io/github/actions/workflow/status/VSCodium/vscodium/stable-macos.yml?branch=master&label=build%28macOS%29)](https://github.com/VSCodium/vscodium/actions/workflows/stable-macos.yml?query=branch%3Amaster) [![build status (windows)](https://img.shields.io/github/actions/workflow/status/VSCodium/vscodium/stable-windows.yml?branch=master&label=build%28windows%29)](https://github.com/VSCodium/vscodium/actions/workflows/stable-windows.yml?query=branch%3Amaster)
**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-install) - [Install with Brew](#install-with-brew) - [Install with Windows Package Manager (WinGet)](#install-with-winget) - [Install with Chocolatey](#install-with-choco) - [Install with Scoop](#install-with-scoop) - [Install with snap](#install-with-snap) - [Install with Package Manager](#install-with-package-manager) - [Install on Arch Linux](#install-on-arch-linux) - [Flatpak Option](#flatpak) - [Build](#build) - [Why Does This Exist](#why) - [More Info](#more-info) - [Supported Platforms](#supported-platforms) ## Download/Install :tada: :tada: Download latest release here: [stable](https://github.com/VSCodium/vscodium/releases) or [insiders](https://github.com/VSCodium/vscodium-insiders/releases) :tada: :tada: [More info / helpful tips are here.](https://github.com/VSCodium/vscodium/blob/master/DOCS.md) #### Install with Brew (Mac) If you are on a Mac and have [Homebrew](https://brew.sh/) installed: ```bash # 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](https://github.com/VSCodium/vscodium/wiki/Troubleshooting#macos).* #### Install with Windows Package Manager (WinGet) If you use Windows and have [Windows Package Manager](https://github.com/microsoft/winget-cli) installed: ```cmd :: 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](https://chocolatey.org) installed (thanks to [@Thilas](https://github.com/Thilas)): ```bash choco install vscodium ``` #### Install with Scoop (Windows) If you use Windows and have [Scoop](https://scoop.sh) installed: ```bash scoop bucket add extras scoop install vscodium ``` #### Install with snap (GNU/Linux) VSCodium is available in the [Snap Store](https://snapcraft.io/) as [Codium](https://snapcraft.io/codium), thanks to the help of the [Snapcrafters](https://github.com/snapcrafters/codium) community. If your GNU/Linux distribution has support for [snaps](https://snapcraft.io/docs/installing-snapd): ```bash 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](https://github.com/VSCodium/vscodium/releases) or [insiders](https://github.com/VSCodium/vscodium-insiders/releases), but you can also install using your favorite package manager and get automatic updates. [@paulcarroty](https://github.com/paulcarroty) has set up a repository with instructions for `apt`, `dnf` and `zypper` [here](https://gitlab.com/paulcarroty/vscodium-deb-rpm-repo). 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](https://wiki.archlinux.org/index.php/Arch_User_Repository), maintained by [@binex-dsk](https://github.com/binex-dsk) as package [vscodium-bin](https://aur.archlinux.org/packages/vscodium-bin/) (stable) and as [vscodium-insiders-bin](https://aur.archlinux.org/packages/vscodium-insiders-bin). If you want to save disk space by having VSCodium use the Electron system-wide, you also have [vscodium-electron](https://aur.archlinux.org/packages/vscodium-electron), maintained by [@m00nw4tch3r](https://aur.archlinux.org/account/m00nw4tch3r). An alternative package [vscodium-git](https://aur.archlinux.org/packages/vscodium-git/), maintained by [@cedricroijakkers](https://github.com/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](https://flathub.org/apps/details/com.vscodium.codium) and the build repo is [here](https://github.com/flathub/com.vscodium.codium). If your distribution has support for [flatpak](https://flathub.org), and you have enabled the [flathub repo](https://flatpak.org/setup/): ```bash flatpak install flathub com.vscodium.codium flatpak run com.vscodium.codium ``` ## Build Build instructions can be found [here](https://github.com/VSCodium/vscodium/blob/master/docs/build.md) ## 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](https://code.visualstudio.com/license) and contain telemetry/tracking. According to [this comment](https://github.com/Microsoft/vscode/issues/60#issuecomment-161792005) 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](https://github.com/VSCodium/vscodium/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](https://github.com/Microsoft/vscode) and follow their [instructions](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#build-and-run). 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: - Pre-built extensions from the GitHub: - [ms-vscode.js-debug-companion](https://github.com/microsoft/vscode-js-debug-companion) - [ms-vscode.js-debug](https://github.com/microsoft/vscode-js-debug) - [ms-vscode.vscode-js-profile-table](https://github.com/microsoft/vscode-js-profile-visualizer) - From [Electron releases](https://github.com/electron/electron/releases) (using [gulp-atom-electron](https://github.com/joaomoreno/gulp-atom-electron)) - electron - ffmpeg ## 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](https://github.com/VSCodium/vscodium/blob/master/DOCS.md) page. ### Extensions and the Marketplace According to the VS Code Marketplace [Terms of Use](https://aka.ms/vsmarketplace-ToU), _you may only install and use Marketplace Offerings with Visual Studio Products and Services._ For this reason, VSCodium uses [open-vsx.org](https://open-vsx.org/), an open source registry for VS Code extensions. See the [Extensions + Marketplace](https://github.com/VSCodium/vscodium/blob/master/DOCS.md#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](https://github.com/VSCodium/vscodium/blob/master/DOCS.md#proprietary-debugging-tools) 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](https://gitter.im/VSCodium/Lobby). 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](https://www.electronjs.org/docs/latest/development/build-instructions-gn#platform-prerequisites). - [x] macOS (`zip`, `dmg`) OS X 10.10 or newer x64 - [x] macOS (`zip`, `dmg`) macOS 11.0 or newer arm64 - [x] GNU/Linux x64 (`deb`, `rpm`, `AppImage`, `tar.gz`) - [x] GNU/Linux x86 (`deb`, `rpm`, `tar.gz`) ([up to v1.35.1](https://code.visualstudio.com/updates/v1_36#_linux-32bit-support-ends)) - [x] GNU/Linux arm64 (`deb`, `tar.gz`) - [x] GNU/Linux armhf (`deb`, `tar.gz`) - [x] Windows 10 / Server 2012 R2 or newer x64 - [x] Windows 10 / Server 2012 R2 or newer x86 - [x] 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](https://github.com/VSCodium/vscodium/blob/master/LICENSE)