Installation

This page gets you to a working story CLI. If you want the shortest path through the learning material, continue with Core concepts and then Quick start.

Supported environment

• Windows x64 or Windows ARM64
• .NET 10
• story: v1beta1 Story files
• Optional GitHub Copilot App Canvas support through the separate rune-story extension

Install the CLI globally after publication

Use the pinned beta when you want the same CLI version used throughout these docs:

dotnet tool install --global Rune.Story.Cli --version 1.0.0-beta.1 --prerelease
story --version

If you intentionally want the newest published prerelease instead of a pinned one:

dotnet tool install --global Rune.Story.Cli --prerelease

Install the CLI locally in a repository

For a repo-local tool install:

dotnet tool install --local Rune.Story.Cli --version 1.0.0-beta.1 --prerelease `
  --create-manifest-if-needed
dotnet tool restore
dotnet tool run story --version

After publication, repositories that commit this tool manifest can restore the pinned package with dotnet tool restore. Contributors validating before publication should use the source-build path below.

Optional: install the Copilot extension

The CLI and the Copilot Canvas extension are separate installs. If you want the Canvas authoring host as well, use the folder URLs collected in Install Rune Story.

Contributors validating from source

Before package publication, validate the checked-in sample directly from this repository. From a Visual Studio Developer PowerShell, build the native engine for the current architecture and bake the canonical quick-start Story:

$platform = if (
  [System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture -eq 'Arm64'
) { 'ARM64' } else { 'x64' }

msbuild .\src\engine\Rune.Engine.Native\Rune.Engine.Native.vcxproj /t:Build /m /nologo `
  /p:Configuration=Release /p:Platform=$platform `
  "/p:SolutionDir=$PWD\"

dotnet run --project .\src\story\Rune.Story.Cli\Rune.Story.Cli.csproj `
  --configuration Release -p:Platform=$platform -p:BuildNativeEngine=false -- `
  bake .\samples\story\quick-start.story.yaml --software

After that works, continue with Quick start or preview one of the checked-in samples such as samples/story/settle-demo.story.yaml.