Installation

Set up the command-line tool once, then generate bindings from your installed npm packages.

For the tool

.NET 10 SDK

The Xantham CLI targets .NET 10.

For the compiler

Node.js and npm

Keep both on PATH. Xantham uses npm to install its matching TypeScript compiler.

Install Xantham

Terminal

dotnet tool install --global xantham
xantham --version

For a prerelease build, add --prerelease to the install command.

Set up TypeScript

Terminal

xantham tsc init
xantham tsc version

tsc init caches the compiler version expected by your installed Xantham tool. tsc version shows the expected version and whether it is available.

Update the tool

Terminal

dotnet tool update --global xantham
xantham tsc init

Check the setup

Terminal

dotnet --version
node --version
npm --version
xantham --help

If xantham is unavailable after installation, add the .NET tools directory to PATH: $HOME/.dotnet/tools on macOS/Linux or %USERPROFILE%\.dotnet\tools on Windows. Open a new terminal after changing PATH.

Generate your first binding

A small package, from install to F# output.

Quick start →

Something failed?

Compiler setup, missing declarations, and generation reports.

Troubleshooting →

Edit this page