Documentation

Use this index to find the documentation for the task or audience you care about. The root README is intentionally a project overview; detailed guidance lives here.

Get started

Choose the supported platform you are using:

The getting-started index summarizes the supported platform mappings and prerequisites.

Commands

The command pages describe shared product behavior without repeating shell-specific syntax:

Install — install an exact SDK under the isolated SDK root
List — show Isolated SDKs and read-only System SDKs
Audit — assess installed SDK servicing and lifecycle state against current Microsoft release metadata
Verify — health-check one installed isolated SDK
Remove — remove an SDK managed under the isolated root
Tool version — identify the tool’s stable release or development source
Interactive mode — persistent sessions, navigation, channel selection, and SDK selection

See the command index for the command/documentation boundary.

Guides

Project and editor use — global.json, direct isolated-host use, VS Code, and project-local workflows
Troubleshooting and safe recovery — failure symptoms, safe recovery, and operational boundaries

Concepts

Use these documents to understand the product’s deeper technical model:

Behavioral contracts

These documents define detailed implementation-independent behavior and intentional shell-specific differences:

Releases

The current published stable version is listed under GitHub Releases. A prepared release-history page does not indicate publication.

Maintainer documentation

Repository development and delivery documentation is intentionally separated from user guidance:

Documentation authority

When documents overlap, use the most focused document for the question at hand:

platform getting-started guides own exact shell syntax and copy/paste examples;
command pages own shared command semantics;
concept and contract pages own deeper technical guarantees and boundaries;
release docs own stable bootstrap/update/rollback policy;
maintainer docs own repository development, testing, issue, and publication procedures.

Compatibility pages may remain at selected historical paths when existing CLI help or published release material points there. Those pages redirect readers to the canonical documents above and are not separate authorities.