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.

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

Sequence diagram showing install, define a GET request step, run the scenario, and review the report.
Installation is the first step in the same flow you will follow through the request-step quick start and report review.

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

Supported Packages

NuGet

Use package `LoadStrike` when you are writing tests in C# on .NET.

Maven

Use package `com.loadstrike:loadstrike` when you are writing tests in Java.

npm

Use package `@loadstrike/loadstrike-sdk` when you are writing tests in TypeScript or JavaScript.

Go modules

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.

Go execution flow

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.

PyPI

Use package `LoadStrike` when you are writing tests in Python.

Import surface

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;