Installation
Install the LoadStrike package for your language and add it to the test project you already use. This page is the starting point before you write a scenario.
Matching docs
Search across docs titles, summaries, groups, and section headings.
Use Up and Down Arrow to move through results, then press Enter to open the active page.
No indexed docs matched that search. Try a broader term or open the docs hub.
What this page helps you do
What this page helps you do
Install the right LoadStrike package for your SDK and confirm the supported runtime before you write a scenario.
Who this is for
Engineers setting up a first local evaluation or adding LoadStrike to an existing test project.
Prerequisites
- A supported runtime for your chosen SDK
- An existing project or repo where the test will live
By the end
Your package installed, your runtime confirmed, and the next step ready.
Choose this path when
Use installation first when you need the exact package name, runtime version, and the shortest path into a runnable scenario.
Visual guide
Guide
Choose The Package
Start with the package that matches your language and toolchain: NuGet `LoadStrike`, Go module `loadstrike.com/sdk/go`, Maven `com.loadstrike:loadstrike`, npm `@loadstrike/loadstrike-sdk`, or PyPI `LoadStrike`. The website serves the Go vanity-import metadata behind `loadstrike.com/sdk/go`, so `go get` and pkg.go.dev resolve to the public Go SDK repository.
Check Runtime Support
Make sure the host matches the supported runtime for that SDK. LoadStrike currently supports C#, Go, Java, Python, TypeScript, and JavaScript. Runtime floors are C# on .NET 8+, Go 1.24+, Java 17+, Python 3.9+, and TypeScript or JavaScript on Node.js 20+.
After Installation
Once the package is installed, import the LoadStrike types for scenarios, steps, simulations, and runner setup in your language. In Go, that means importing `loadstrike "loadstrike.com/sdk/go"` from the public vanity module path and configuring a valid runner key before execution starts.
Getting started samples
Use these install snippets to verify the exact package names, Go module path, and import surfaces before you start the first scenario in your SDK.
Go users install module loadstrike.com/sdk/go and import it as loadstrike "loadstrike.com/sdk/go". The website serves the vanity-import metadata for that public module path, so go get and pkg.go.dev resolve the GitHub repository automatically. After installation, configure a valid runner key and run the workload directly from Go code.
If you run these examples locally, add a valid runner key before execution starts. Set it with WithRunnerKey("...") or the config key LoadStrike:RunnerKey.
Install
using LoadStrike;
dotnet add package LoadStrike
Module path: loadstrike.com/sdk/go. The website serves the vanity-import metadata for this public path, so `go get` and pkg.go.dev resolve the GitHub repository automatically. Install the module, configure a valid runner key, and run workloads directly from Go.
go get loadstrike.com/sdk/go
import loadstrike "loadstrike.com/sdk/go"
Use the published Maven Central artifact.
<dependency>
<groupId>com.loadstrike</groupId>
<artifactId>loadstrike</artifactId>
<version>latest</version>
</dependency>
import com.loadstrike.runtime.LoadStrikeRuntime.LoadStrikeRunner;
pip install LoadStrike
from loadstrike_sdk import LoadStrikeRunner
npm install @loadstrike/loadstrike-sdk
import { LoadStrikeRunner } from "@loadstrike/loadstrike-sdk";
npm install @loadstrike/loadstrike-sdk
const { LoadStrikeRunner } = require("@loadstrike/loadstrike-sdk");
Supported Packages
Use package `LoadStrike` when you are writing tests in C# on .NET.
Use package `com.loadstrike:loadstrike` when you are writing tests in Java.
Use package `@loadstrike/loadstrike-sdk` when you are writing tests in TypeScript or JavaScript.
Use module `loadstrike.com/sdk/go` and install it with `go get loadstrike.com/sdk/go` when you are writing tests in Go. The website serves the vanity-import metadata for that path so the Go toolchain and pkg.go.dev resolve the public repository automatically.
Use module `loadstrike.com/sdk/go`, configure a valid runner key, and run workloads directly from Go without adding a separate runner package to your project.
Use package `LoadStrike` when you are writing tests in Python.
After install, import the LoadStrike runtime types for scenarios, steps, simulations, and runner configuration in your language. In Go, use `loadstrike "loadstrike.com/sdk/go"`.
using LoadStrike;