Install Rune Story

If you are following the Learn curriculum, start with Installation. This page keeps the detailed release-channel and extension-install notes in one place.

The first public beta ships two explicit artifacts:

1. the story .NET tool (Rune.Story.Cli 1.0.0-beta.1), and
2. the source-only rune-story Copilot extension.

Installing one does not silently install the other.

Publication gate: These commands and repository URLs become valid only after the release workflow has published Rune.Story.Cli 1.0.0-beta.1 and created both the v1.0.0-beta.1 tag and latest branch. Their absence means the coordinated release is not complete; use the source checkout for development validation.

Version axes to keep straight

Surface	Current value	Meaning
Story schema	v1beta1	YAML document headers such as story: v1beta1
CLI product	1.0.0-beta.1	Rune.Story.Cli package version and story --version
Canvas protocol	1	Extension-to-host wire protocol
Extension manifest	1	copilot-extension.json format

Install the CLI globally after publication

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

The release guide also supports an intentionally moving install:

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

Use the pinned version when you want a reproducible setup. Use the unpinned prerelease command only when you intentionally want the latest published beta.

Install the CLI locally in a repository after publication

For repo-local use:

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, a repository with the checked-in tool manifest can restore the pinned package with dotnet tool restore. Before publication, use the source-build workflow in Installation.

Install the Copilot extension

The official extension is a multi-file source folder, not a single extension.mjs download. After the publication gate is satisfied, use one of these repository folder URLs in the Copilot App:

https://github.com/devkanro/Rune/tree/v1.0.0-beta.1/.github/extensions/rune-story
https://github.com/devkanro/Rune/tree/latest/.github/extensions/rune-story

• Use the tag-pinned URL for reproducibility.
• Use latest when you intentionally want the most recently completed coordinated release.

The extension is source-only and invokes the explicitly installed story tool. It is not a hidden binary downloader.

Supported environment

• Windows x64 or Windows ARM64
• .NET 10
• GitHub Copilot App with Canvas extensions enabled

WinGet is intentionally deferred until a stable release.

After install

• Use First successful run to verify the CLI.
• Use Preview, live, and export for common commands.
• Use Release notes for compatibility, rollback, and asset details.