Packages

Install the components you need.

These SDK packages are available in Runic SDK 0.7.0-preview.5. Keep SDK dependencies on the same preview version. Command Line and Translations are released independently.

Choose by goal

What do you want to do?

Each goal lists the smallest set of packages that reaches it. Run .NET package commands from your project directory and npm commands from your frontend directory. Runic Translations and Runic Command Line have their own Translations and Command Line installation guides.

Goal

Start a new desktop app

The creator asks for a frontend, package manager, host and ViewModel library, then runs the template. The generated project references every package it needs.

Runic.Create Guided creator; runs without installing.
```
dnx Runic.Create@0.7.0-preview.5
```
Runic.Application.Templates The runic-app template, for dotnet new.
```
dotnet new install Runic.Application.Templates@0.7.0-preview.5
```

Getting started

Goal

Add Windows and Views to an existing app

Reference one host adapter in the .NET project and the shared runtime plus your framework binding in the frontend.

Runic.Application.CsWebUi Host adapter for a browser or WebView window, or:
```
dotnet add package Runic.Application.CsWebUi --version 0.7.0-preview.5
```
Runic.Application.Desktop Host adapter for Runic Desktop native windows.
```
dotnet add package Runic.Application.Desktop --version 0.7.0-preview.5
```

Runic.Application.ReactiveUI Only for ReactiveUI ViewModels.

dotnet add package Runic.Application.ReactiveUI --version 0.7.0-preview.5

dotnet-runic dotnet runic dev and doctor.

dotnet tool install --local dotnet-runic --version 0.7.0-preview.5

@runic-artifex/views Runtime for the generated TypeScript clients.
```
npm install --save-exact @runic-artifex/views@0.7.0-preview.5
```
@runic-artifex/react Or @runic-artifex/vue, @runic-artifex/svelte, @runic-artifex/angular.
```
npm install --save-exact @runic-artifex/react@0.7.0-preview.5
```

Add Runic to an existing app

Goal

Adopt navigation in WPF

Keep native Views and existing ViewModels while adopting the shared navigation engine, WPF hosts and idiomatic MVVM commands.

Runic.Navigation.Wpf Native hosts and dispatcher context; includes Runic.Navigation.
```
dotnet add package Runic.Navigation.Wpf --version 0.7.0-preview.5
```
Runic.Navigation.ReactiveUI Only for ReactiveUI observable and command helpers; choose the .Reactive flavor for System.Reactive.
```
dotnet add package Runic.Navigation.ReactiveUI --version 0.7.0-preview.5
```

Adopt Runic incrementally in WPF

Goal

Replace one WPF View with a web View

Embed a web presentation in the existing WPF shell and retain the same application-owned model, services and navigation entry.

Runic.Application.Wpf Experimental child WebView2 host; includes the Desktop bridge.
```
dotnet add package Runic.Application.Wpf --version 0.7.0-preview.5
```
@runic-artifex/views Shared browser runtime; add the binding for your frontend framework.
```
npm install --save-exact @runic-artifex/views@0.7.0-preview.5
```

Migrate individual Views

Goal

Test Windows and Views

Drive the real ViewModels and generated Bridges without a browser or native window. Frontend tests use the mock Bridge in @runic-artifex/views.

Runic.Application.Testing In the .NET test project.

dotnet add package Runic.Application.Testing --version 0.7.0-preview.5

Testing in the tutorial

Goal

Open native windows and use platform services

Runic Desktop hosts embedded WebViews in native windows; the platform packages add file dialogs, notifications, appearance and inhibition.

Runic.Desktop Native windows and embedded WebViews.

dotnet add package Runic.Desktop --version 0.7.0-preview.5

Runic.Platform Platform service contracts; add the Runic.Platform.* adapter for each operating system.
```
dotnet add package Runic.Platform --version 0.7.0-preview.5
```

Choose a desktop host

Goal

Embed and serve a frontend

Pack a frontend build into the executable and serve it from ASP.NET Core or a Runic Desktop window.

Runic.Assets Archive, manifest and build integration.

dotnet add package Runic.Assets --version 0.7.0-preview.5

Runic.Assets.AspNetCore Serve from ASP.NET Core, or:

dotnet add package Runic.Assets.AspNetCore --version 0.7.0-preview.5

Runic.Assets.Desktop Serve in a Runic Desktop window.

dotnet add package Runic.Assets.Desktop --version 0.7.0-preview.5

Embed and serve assets

Public registries

All packages

No GitHub package feed or token is required. For local .NET tools, create a manifest with dotnet new tool-manifest if the project does not already have one.

Runic.Platform.Administration.Windows

Windows administration · NuGet

Experimental Windows administration APIs. Administrative writes and domain services still need native validation. See the release notes for tested scenarios.

dotnet add package Runic.Platform.Administration.Windows --version 0.7.0-preview.5