Table of Contents

Installation Guide

Prerequisites

Windows

Download and run the latest installer from the Releases page:

CosmosSetup-<version>-windows.exe

After installation, open a new terminal and verify:

cosmos check

To uninstall, use Add or Remove Programs in Windows Settings.

Linux / macOS

Install the Cosmos CLI and all dependencies:

dotnet tool install -g Cosmos.Tools
cosmos install

This will install all required tools via your package manager (apt, dnf, pacman, or brew), the Cosmos patcher, project templates, and the VS Code extension.

Verify installation:

cosmos check

To uninstall:

cosmos uninstall
dotnet tool uninstall -g Cosmos.Tools

To update:

cosmos update

Run it inside a kernel project directory to also move the project's Cosmos version pins (the Sdk="Cosmos.Sdk/..." attribute and Cosmos.* package references) to the latest release. Additional options:

Option Effect
cosmos update --check Report available updates without installing anything
cosmos update --no-project Update the tools but leave project files untouched
cosmos update --version <VERSION> Move the CLI, patcher, templates, and project pins to a specific version (system tools always follow the tools-latest bundles)

Quick Start

Once installed, see Kernel Startup to create your first kernel and learn the boot flow.

Edit this page