Get Started

Installation

Goal

Install the HexaEight SDK in your project and verify it loads.

Prerequisites

• For .NET — .NET 8, 9, or 10 SDK
• For Node.js — Node.js 18 or later, on Linux, macOS, or WSL2

.NET

dotnet add package HexaEight.Bridge --prerelease

The package multi-targets net8.0, net9.0, and net10.0. Your project's TFM determines which build is loaded. No additional configuration is required.

Node.js

npm install @hexaeight/sdk@preview

The Node.js SDK bundles a .NET runtime and uses node-api-dotnet to load the underlying SDK code. The postinstall script will offer to install .NET 10 automatically if it is not already present.

Python

The Python SDK is in development. When it ships, installation will be:

pip install hexaeight-sdk

Verify the install

Run a short program that loads the SDK and prints its version:

// .NET — verify-install.csx
#r "nuget: HexaEight.Bridge, *-*"
using HexaEight.Bridge;
Console.WriteLine($"HexaEight.Bridge {Client.BridgeVersion}");
Console.WriteLine($"Target framework: {Client.TargetFramework}");

// Node.js — verify-install.js
import pkg from '@hexaeight/sdk/package.json' with { type: 'json' };
console.log(`HexaEight SDK ${pkg.version}`);

Common issues