Skip to content
Thymian
Blog

Thymian CLI Reference

Commands

Section titled “Commands”

thymian analyze

Section titled “thymian analyze”

Analyze recorded API traffic against specifications and configured rule sets.

USAGE
  $ thymian analyze [--verbose] [--debug] [--guidance] [--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]
    [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>]
    [--suppress-feedback] [--validate-specs] [--validate-traffic-source]


FLAGS
  --cwd=<value>                   [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working
                                  directory.
  --[no-]validate-traffic-source  Validate included traffic sources and fail on source-schema validation errors.


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.


DESCRIPTION
  Analyze recorded API traffic against specifications and configured rule sets.


EXAMPLES
  $ thymian analyze


  $ thymian analyze --traffic har:./traffic.har


  $ thymian analyze --spec openapi:./openapi.yaml --traffic har:./traffic.har

See code: dist/commands/analyze.js

thymian config show

Section titled “thymian config show”

Show the current Thymian configuration.

USAGE
  $ thymian config show [--verbose] [--debug] [--guidance] [--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]
    [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>]
    [--suppress-feedback] [--validate-specs] [--yaml]


FLAGS
  --cwd=<value>  [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working directory.
  --[no-]yaml    Output configuration in YAML format.


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.


DESCRIPTION
  Show the current Thymian configuration.

See code: dist/commands/config/show.js

thymian explain rule RULENAME

Section titled “thymian explain rule RULENAME”

Explain a single rule: what it checks, why it matters, and how to act on it. Any rule in the configured rule sets can be explained regardless of its severity, so the inherited –rule-severity flag has no effect here.

USAGE
  $ thymian explain rule RULENAME [--verbose] [--debug] [--guidance] [--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] [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout
    <value>] [--cwd <value>] [--suppress-feedback] [--validate-specs]


ARGUMENTS
  RULENAME  Canonical rule id, e.g. rfc9110/<rule-name> (as shown by `thymian rules list`).


FLAGS
  --cwd=<value>  [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working directory.


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.


DESCRIPTION
  Explain a single rule: what it checks, why it matters, and how to act on it. Any rule in the configured rule sets can
  be explained regardless of its severity, so the inherited --rule-severity flag has no effect here.


EXAMPLES
  $ thymian explain rule rfc9110/origin-server-should-send-501-response-for-unrecognized-method

See code: dist/commands/explain/rule.js

thymian feedback

Section titled “thymian feedback”

Share CLI feedback or report the most recent command error.

USAGE
  $ thymian feedback [--suppress-feedback]


BASE FLAGS
  --suppress-feedback  Suppress feedback messages from Thymian.


DESCRIPTION
  Share CLI feedback or report the most recent command error.

See code: dist/commands/feedback.js

thymian generate config

Section titled “thymian generate config”

Generate a Thymian configuration file for one or more API specifications.

USAGE
  $ thymian generate config [--suppress-feedback] [--cwd <value>] [--interactive] [--output <value>] [--for-spec
    type:location...] [--for-report type:location...]


FLAGS
  --cwd=<value>                  [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working
                                 directory.
  --for-report=type:location...  External report input in the format <type>:<location> (e.g. spectral:./report.json).
                                 Adds a reports entry for `thymian report convert`.
  --for-spec=type:location...    Specification input in the format <type>:<location>. Skips auto-detection and adds each
                                 provided specification directly.
  --[no-]interactive             Run in interactive mode. Use --no-interactive for automation.
  --output=<value>               Output path for the generated configuration file. Defaults to thymian.config.yaml in
                                 the working directory.


BASE FLAGS
  --suppress-feedback  Suppress feedback messages from Thymian.


DESCRIPTION
  Generate a Thymian configuration file for one or more API specifications.


EXAMPLES
  $ thymian generate config


  $ thymian generate config --no-interactive


  $ thymian generate config --output my-api.config.yaml


  $ thymian generate config --for-spec openapi:./petstore.yaml


  $ thymian generate config --for-spec openapi:./petstore.yaml --for-spec openapi:./orders.yaml


  $ thymian generate config --for-spec openapi:./petstore.yaml --for-report spectral:./report.json

See code: dist/commands/generate/config.js

thymian generate rule

Section titled “thymian generate rule”

Scaffold a new HTTP rule using the httpRule builder.

USAGE
  $ thymian generate rule [--suppress-feedback] [--cjs] [--prefix <value>] [--url <value>] [--output <value>]
    [--cwd <value>]


FLAGS
  --cjs             Generate rule using CommonJS syntax. With --output, the file is written as .cjs.
  --cwd=<value>     [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working directory.
  --output=<value>  Write the generated rule to a file instead of printing to stdout.
  --prefix=<value>  Prefix for the rule name that is automatically prepended.
  --url=<value>     Reference URL for the rule.


BASE FLAGS
  --suppress-feedback  Suppress feedback messages from Thymian.


DESCRIPTION
  Scaffold a new HTTP rule using the httpRule builder.


EXAMPLES
  $ thymian generate rule


  $ thymian generate rule --prefix my-org/


  $ thymian generate rule --cjs


  $ thymian generate rule --output src/rules/my-rule.rule.ts


  $ thymian generate rule --cjs --output src/rules/my-rule.rule.cjs

See code: dist/commands/generate/rule.js

thymian help [COMMAND]

Section titled “thymian help [COMMAND]”

Display help for thymian.

USAGE
  $ thymian help [COMMAND...] [-n]


ARGUMENTS
  [COMMAND...]  Command to show help for.


FLAGS
  -n, --nested-commands  Include all nested commands in the output.


DESCRIPTION
  Display help for thymian.

See code: @oclif/plugin-help

thymian lint

Section titled “thymian lint”

Lint API specifications against configured rule sets.

USAGE
  $ thymian lint [--verbose] [--debug] [--guidance] [--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]
    [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>]
    [--suppress-feedback] [--validate-specs]


FLAGS
  --cwd=<value>  [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working directory.


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.


DESCRIPTION
  Lint API specifications against configured rule sets.


EXAMPLES
  $ thymian lint


  $ thymian lint --spec openapi:./openapi.yaml


  $ thymian lint --rule-set @thymian/rules-rfc-9110

See code: dist/commands/lint.js

thymian plugins list

Section titled “thymian plugins list”

List all registered Thymian plugins.

USAGE
  $ thymian plugins list [--verbose] [--debug] [--guidance] [--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]
    [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>]
    [--suppress-feedback] [--validate-specs]


FLAGS
  --cwd=<value>  [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working directory.


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.


DESCRIPTION
  List all registered Thymian plugins.

See code: dist/commands/plugins/list.js

thymian report convert

Section titled “thymian report convert”

Convert external tool reports into a canonical Thymian report.

USAGE
  $ thymian report convert [--verbose] [--debug] [--guidance] [--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]
    [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>]
    [--suppress-feedback] [--validate-specs] [--report type:location...]


FLAGS
  --cwd=<value>              [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working
                             directory.
  --report=type:location...  External report input in the format <type>:<location> (e.g. spectral:./report.json).


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.


DESCRIPTION
  Convert external tool reports into a canonical Thymian report.


EXAMPLES
  $ thymian report convert --report spectral:./report.json


  $ thymian report convert --report spectral:./report.json --spec openapi:./api.yaml

See code: dist/commands/report/convert.js

thymian report merge

Section titled “thymian report merge”

Merge multiple reports — Thymian JSON reports or convertible external formats — into one Thymian report.

USAGE
  $ thymian report merge [--verbose] [--debug] [--guidance] [--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]
    [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>]
    [--suppress-feedback] [--validate-specs] [--report type:location...]


FLAGS
  --cwd=<value>              [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working
                             directory.
  --report=type:location...  External report input in the format <type>:<location> (e.g. spectral:./report.json).


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.


DESCRIPTION
  Merge multiple reports — Thymian JSON reports or convertible external formats — into one Thymian report.


EXAMPLES
  $ thymian report merge --report thymian:./a.json --report thymian:./b.json


  $ thymian report merge --report thymian:./thymian-report.json --report spectral:./spectral-report.json --spec openapi:./api.yaml

See code: dist/commands/report/merge.js

thymian request

Section titled “thymian request”
USAGE
  $ thymian request [--verbose] [--debug] [--guidance] [--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]
    [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>]
    [--suppress-feedback] [--validate-specs] [--validate]


FLAGS
  --cwd=<value>  [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working directory.
  --validate


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.

See code: dist/commands/request.js

thymian rules list

Section titled “thymian rules list”

List all rules from the configured rule sets.

USAGE
  $ thymian rules list [--verbose] [--debug] [--guidance] [--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]
    [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>]
    [--suppress-feedback] [--validate-specs] [--type static|analytics|test|informational...] [--to-csv <value>]


FLAGS
  --cwd=<value>       [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working directory.
  --to-csv=<value>    Output rules to CSV file.
  --type=<option>...  Filter rules by type (static, analytics, test, informational). Can be specified multiple times.
                      <options: static|analytics|test|informational>


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.


DESCRIPTION
  List all rules from the configured rule sets.


EXAMPLES
  $ thymian rules list


  $ thymian rules list --rule-set @thymian/rules-rfc-9110


  $ thymian rules list --rule-severity hint


  $ thymian rules list --type static

See code: dist/commands/rules/list.js

thymian serve

Section titled “thymian serve”

Run Thymian in serve mode.

USAGE
  $ thymian serve [--verbose] [--debug] [--guidance] [--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]
    [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>]
    [--suppress-feedback] [--validate-specs]


FLAGS
  --cwd=<value>  [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working directory.


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.


DESCRIPTION
  Run Thymian in serve mode.


EXAMPLES
  $ thymian serve

See code: dist/commands/serve.js

thymian test

Section titled “thymian test”

Test API specifications by running live requests against configured rule sets.

USAGE
  $ thymian test [--verbose] [--debug] [--guidance] [--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]
    [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>]
    [--suppress-feedback] [--validate-specs] [--target-url <value>]


FLAGS
  --cwd=<value>         [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working directory.
  --target-url=<value>  Override the target URL for all test requests. When set, all requests are sent to this origin
                        instead of the servers defined in the specification.


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.


DESCRIPTION
  Test API specifications by running live requests against configured rule sets.


EXAMPLES
  $ thymian test


  $ thymian test --spec openapi:./openapi.yaml


  $ thymian test --rule-set @thymian/rules-rfc-9110


  $ thymian test --target-url http://localhost:8080

See code: dist/commands/test.js

thymian validate

Section titled “thymian validate”

Validate API specifications resolved from config or –spec.

USAGE
  $ thymian validate [--verbose] [--debug] [--guidance] [--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]
    [--sort-reports-by rule|endpoint|severity] [--timeout <value>] [--idle-timeout <value>] [--cwd <value>]
    [--suppress-feedback] [--validate-specs]


FLAGS
  --cwd=<value>  [default: /home/runner/work/thymian/thymian/packages/thymian] Set current working directory.


BASE FLAGS
  --[no-]autoload                      Automatically load and initialize plugins from the configuration file.
  --config=<value>                     Path to thymian configuration file.
  --debug                              Run thymian in debug mode.
  --[no-]guidance                      Show guidance hints on stderr. Defaults to true for TTY, false for non-TTY.
  --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: ] Load an additional plugin package or relative plugin path before
                                       running the command. Can be used multiple times.
  --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>
  --sort-reports-by=<option>           Group report findings by rule, endpoint, or severity (default: endpoint). Affects
                                       the CLI report and any configured reporter that supports grouping.
                                       <options: rule|endpoint|severity>
  --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).
  --[no-]validate-specs                Validate included specifications and fail on schema validation errors.
  --verbose                            Run thymian in verbose mode.


DESCRIPTION
  Validate API specifications resolved from config or --spec.


EXAMPLES
  $ thymian validate


  $ thymian validate --spec openapi:./openapi.yaml

See code: dist/commands/validate.js

thymian version

Section titled “thymian version”
USAGE
  $ thymian version [--json] [--verbose]


FLAGS
  --verbose  Show additional information about the CLI.


GLOBAL FLAGS
  --json  Format output as json.


FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.


    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version

GitHubDiscordTwitterRedditLinkedInRSS