CLI Reference
Commands
Section titled “Commands”thymian sampler check
Section titled “thymian sampler check”Verify that all sampled transactions can be executed against the live API.
USAGE $ thymian sampler check [--json] [--verbose] [--debug] [--log-level trace|debug|info|warn|error|silent] [--config <value>] [--autoload] [--plugin <value>...] [--option <plugin>.<path>=<value>...] [--spec type:location...] [--traffic type:location...] [--rule-set package-name...] [--rule-severity off|error|warn|hint] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>] [--suppress-feedback] [--incremental] [--target-url <value>]
FLAGS --cwd=<value> [default: /home/runner/work/thymian/thymian/packages/plugin-sampler] Set current working directory. --[no-]incremental Check transactions one by one and offer to generate hooks for failures. --target-url=<value> Override the target URL for all check requests. When set, all requests are sent to this origin instead of the servers defined in the specification.
BASE FLAGS --[no-]autoload Disable automatic loading and initialization of plugins based on configuration file. --config=<value> Path to thymian configuration file. --debug Run thymian in debug mode. --idle-timeout=<value> [default: 500] Set the duration in ms to waited for events and actions when closing Thymian. --log-level=<option> Set log level (trace, debug, info, warn, error, silent). When set to trace, all events are traced. <options: trace|debug|info|warn|error|silent> --option=<plugin>.<path>=<value>... Override plugin options. Format: <pluginName>.<property.path>=<value>. Supports nested paths (dot notation) and array indices (bracket notation). --plugin=<value>... [default: ] --rule-set=package-name... Add a rule set package to use for validation (e.g. @thymian/rules-rfc-9110). Can be specified multiple times. --rule-severity=<option> Set the minimum rule severity threshold for rule loading (off, error, warn, hint). Only rules at or above this severity are loaded. <options: off|error|warn|hint> --spec=type:location... Specification input in the format <type>:<location> (e.g. openapi:./openapi.yaml). --suppress-feedback Suppress feedback messages from Thymian. --timeout=<value> [default: 10000] Set the duration in ms to wait for anything that happens in Thymian. --traffic=type:location... Traffic input in the format <type>:<location> (e.g. har:./traffic.har). --verbose Run thymian in verbose mode.
GLOBAL FLAGS --json Format output as json.
DESCRIPTION Verify that all sampled transactions can be executed against the live API.
EXAMPLES $ thymian sampler check
$ thymian sampler check --target-url http://localhost:8080
$ thymian sampler check --incrementalSee code: dist/cli/commands/sampler/check.js
thymian sampler generate hook
Section titled “thymian sampler generate hook”USAGE $ thymian sampler generate hook [--json] [--verbose] [--debug] [--log-level trace|debug|info|warn|error|silent] [--config <value>] [--autoload] [--plugin <value>...] [--option <plugin>.<path>=<value>...] [--spec type:location...] [--traffic type:location...] [--rule-set package-name...] [--rule-severity off|error|warn|hint] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>] [--suppress-feedback] [--for-transaction <value>]
FLAGS --cwd=<value> [default: /home/runner/work/thymian/thymian/packages/plugin-sampler] Set current working directory. --for-transaction=<value> For which transaction do you want to generate a hook?
BASE FLAGS --[no-]autoload Disable automatic loading and initialization of plugins based on configuration file. --config=<value> Path to thymian configuration file. --debug Run thymian in debug mode. --idle-timeout=<value> [default: 500] Set the duration in ms to waited for events and actions when closing Thymian. --log-level=<option> Set log level (trace, debug, info, warn, error, silent). When set to trace, all events are traced. <options: trace|debug|info|warn|error|silent> --option=<plugin>.<path>=<value>... Override plugin options. Format: <pluginName>.<property.path>=<value>. Supports nested paths (dot notation) and array indices (bracket notation). --plugin=<value>... [default: ] --rule-set=package-name... Add a rule set package to use for validation (e.g. @thymian/rules-rfc-9110). Can be specified multiple times. --rule-severity=<option> Set the minimum rule severity threshold for rule loading (off, error, warn, hint). Only rules at or above this severity are loaded. <options: off|error|warn|hint> --spec=type:location... Specification input in the format <type>:<location> (e.g. openapi:./openapi.yaml). --suppress-feedback Suppress feedback messages from Thymian. --timeout=<value> [default: 10000] Set the duration in ms to wait for anything that happens in Thymian. --traffic=type:location... Traffic input in the format <type>:<location> (e.g. har:./traffic.har). --verbose Run thymian in verbose mode.
GLOBAL FLAGS --json Format output as json.
ALIASES $ thymian sampler g h $ thymian sampler generate hSee code: dist/cli/commands/sampler/generate/hook.js
thymian sampler init
Section titled “thymian sampler init”USAGE $ thymian sampler init [--json] [--verbose] [--debug] [--log-level trace|debug|info|warn|error|silent] [--config <value>] [--autoload] [--plugin <value>...] [--option <plugin>.<path>=<value>...] [--spec type:location...] [--traffic type:location...] [--rule-set package-name...] [--rule-severity off|error|warn|hint] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>] [--suppress-feedback] [--overwrite] [--check]
FLAGS --[no-]check After initialization, run sampler check to verify all transactions can be executed. --cwd=<value> [default: /home/runner/work/thymian/thymian/packages/plugin-sampler] Set current working directory. --overwrite Overwrite existing samples.
BASE FLAGS --[no-]autoload Disable automatic loading and initialization of plugins based on configuration file. --config=<value> Path to thymian configuration file. --debug Run thymian in debug mode. --idle-timeout=<value> [default: 500] Set the duration in ms to waited for events and actions when closing Thymian. --log-level=<option> Set log level (trace, debug, info, warn, error, silent). When set to trace, all events are traced. <options: trace|debug|info|warn|error|silent> --option=<plugin>.<path>=<value>... Override plugin options. Format: <pluginName>.<property.path>=<value>. Supports nested paths (dot notation) and array indices (bracket notation). --plugin=<value>... [default: ] --rule-set=package-name... Add a rule set package to use for validation (e.g. @thymian/rules-rfc-9110). Can be specified multiple times. --rule-severity=<option> Set the minimum rule severity threshold for rule loading (off, error, warn, hint). Only rules at or above this severity are loaded. <options: off|error|warn|hint> --spec=type:location... Specification input in the format <type>:<location> (e.g. openapi:./openapi.yaml). --suppress-feedback Suppress feedback messages from Thymian. --timeout=<value> [default: 10000] Set the duration in ms to wait for anything that happens in Thymian. --traffic=type:location... Traffic input in the format <type>:<location> (e.g. har:./traffic.har). --verbose Run thymian in verbose mode.
GLOBAL FLAGS --json Format output as json.See code: dist/cli/commands/sampler/init.js