vscodium README

The project's README from github.com/VSCodium/vscodium. As one markdown file: README.md.

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

: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:

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.

Previously Supported Platforms

Special thanks

@jaredreich for the logo
@PalinuroSec for CDN and domain name
MacStadium logo for providing a Mac mini M1
@daiyam for macOS certificate
SignPath logo free code signing on Windows provided by SignPath.io, certificate by SignPath Foundation

License

MIT

vscodium (VSCodium/vscodium)

Searching Database…

33.7K ·GitHub
这是什么?VSCodium 是以自由许可证发布的 Visual Studio Code 二进制版本:自动化构建脚本把微软官方的 vscode 仓库构建成 MIT 许可的版本,关闭了遥测功能,也没有微软品牌标识。
它是 VS Code 的分支(fork)吗?不是。这个仓库只包含构建脚本:微软是在同一份源代码上叠加自定义的 product.json 来构建 VS Code 的,而 VSCodium 发布的是那份干净的构建,不包含微软专属的端点。
我能从 VS Code 市场安装扩展吗?不能全部安装。市场的服务条款只允许官方 VS Code 产品使用,所以 VSCodium 使用的是 open-vsx.org 这个扩展仓库,有些只授权给官方版本使用的扩展无法使用。
它能在哪些平台上运行?macOS 12 及以上版本(x64 和 arm64)、Windows 10 或 Server 2012 R2 及以上版本(x64 和 arm64),以及 x64、arm64、riscv64、loong64 和 ppc64le 架构的 GNU/Linux——提供 deb、rpm、AppImage、snap、tar.gz、zip/dmg 和 Flatpak 格式。
遥测功能开箱即关吗?发布的二进制文件默认已关闭遥测,文档(Docs)页面说明了如何彻底关闭剩余的遥测功能,还提供了从 Visual Studio Code 迁移到 VSCodium 的小技巧。
它和官方下载的 VS Code 有什么区别?微软的版本采用非自由开源许可证,并带有遥测和跟踪功能;VSCodium 的二进制文件采用 MIT 许可证,且已关闭遥测——同样的编辑器,更自由的许可证,没有跟踪。
新的 VS Code 版本发布后多久能构建出来?构建脚本每天都会运行,只要微软发布新版本就会发布对应的二进制文件;如果上游没有更新,构建会提前退出——因此 VSCodium 始终与官方 VS Code 版本保持同步。
Windows 版二进制文件有代码签名吗?有——Windows 上的免费代码签名由 SignPath.io 提供,证书来自 SignPath Foundation;macOS 版本则使用 @daiyam 提供的证书进行签名。
What are similar projects?toast, edit, LightTable, CodeEdit, vscode, lapce, atom, Vim
Creator
VSCodium
Size
34.4 MB
Stars
33.7K
Age
8y
Commits · 90 Days