CLI Arguments

Override runner options at execution time through command-line arguments.

Format

Use --key=value syntax only (arguments without -- are ignored). Boolean CLI options use strict true/false parsing and key-only flags do not imply true. Enum-like keys follow strict token parsing: NodeType supports Single/SingleNode/Coordinator/Agent (or 0/1/2). ReportFormats accepts strict tokens only: txt, html, csv, md (plus markdown alias). Examples: --testsuite=orders, --reportformats=html,csv, --nodetype=coordinator, --runnerkey=rkl_xxx.

Supported Arguments

Common keys include config/infraconfig, suite/name/session, reports options, node/cluster options, target scenario options, logging options, restart attempts, and licensing options.

When To Use

CLI arguments are useful for CI/CD and containerized execution where the same binary should run multiple environments without code changes.

Feature Usage Samples

How to use snippets for CLI Arguments.

Switch between C#, Java, Python, TypeScript, and JavaScript to see the native SDK shape for this sample.

Licensing note: every runnable sample requires a valid runner key via WithRunnerKey("...") or config key LoadStrike:RunnerKey.

CLI Args

LoadStrikeRunner.RegisterScenarios(scenario).Run(
    "--testsuite=smoke",
    "--reportfolder=./reports",
    "--reportformats=html,csv",
    "--runnerkey=rkl_your_local_runner_key"
);

import com.loadstrike.runtime.LoadStrikeRuntime.LoadStrikeRunner;

LoadStrikeRunner.registerScenarios(scenario).run(
    "--testsuite=smoke",
    "--reportfolder=./reports",
    "--reportformats=html,csv",
    "--runnerkey=rkl_your_local_runner_key"
);

from loadstrike_sdk import LoadStrikeRunner

LoadStrikeRunner.register_scenarios(scenario).run(
    "--testsuite=smoke",
    "--reportfolder=./reports",
    "--reportformats=html,csv",
    "--runnerkey=rkl_your_local_runner_key",
)

import { LoadStrikeRunner } from "@loadstrike/loadstrike-sdk";

await LoadStrikeRunner.registerScenarios(scenario).run(
  "--testsuite=smoke",
  "--reportfolder=./reports",
  "--reportformats=html,csv",
  "--runnerkey=rkl_your_local_runner_key"
);

const { LoadStrikeRunner } = require("@loadstrike/loadstrike-sdk");

await LoadStrikeRunner.registerScenarios(scenario).run(
  "--testsuite=smoke",
  "--reportfolder=./reports",
  "--reportformats=html,csv",
  "--runnerkey=rkl_your_local_runner_key"
);

Syntax

--key=value

Use double-dash argument syntax only; tokens without the leading double dash are ignored.

Boolean values

Boolean CLI inputs require explicit true or false values and do not infer true from key-only flags.

NodeType

Accepts Single, SingleNode, Coordinator, Agent, or numeric 0, 1, and 2 tokens.

Environment detection

RunnerEnvironment is no longer a supported CLI override; LoadStrike detects local vs remote execution automatically and applies the matching key rules.