Skip to content

Commit 422d466

Browse files
committed
docs(cli): enhance command options documentation for severity and code filters
1 parent 7e4e9f2 commit 422d466

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

docs/03_reference/cli.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -537,6 +537,16 @@ robotcode analyze code [OPTIONS] [PATHS]...
537537
Extend the exit code mask with the specified values. This appends to the default mask, defined in the config file.
538538

539539

540+
- `--severity [error|warn|warning|info|information|hint] *`
541+
542+
Only report diagnostics of these severities. Repeatable and comma-separated. Filtered-out severities are ignored entirely — they don't appear in the output, the summary or the exit code. When omitted, all severities are reported.
543+
544+
545+
- `--code CODE *`
546+
547+
Only report diagnostics with these codes (e.g. `KeywordNotFound`). Repeatable and comma-separated; matching is case-insensitive. Unlike the modifiers, this filters without changing severity. Combined with --severity, both must match. When omitted, all codes are reported.
548+
549+
540550
- `--load-library-timeout SECONDS`
541551

542552
Timeout (in seconds) for loading libraries and variable files during analysis. Must be > 0. Overrides config file and environment variable when set. [env var: ROBOTCODE_LOAD_LIBRARY_TIMEOUT]
@@ -552,6 +562,26 @@ robotcode analyze code [OPTIONS] [PATHS]...
552562
Enable or disable caching of fully analyzed namespace data to disk. Can speed up startup for large projects by skipping re-analysis of unchanged files.
553563

554564

565+
- `--show-tracebacks / --no-show-tracebacks`
566+
567+
Include the full diagnostic message in the text output, including Python tracebacks and PYTHONPATH listings that Robot Framework appends to import errors. Off by default to keep output concise. Has no effect on JSON output, which always carries the full message.
568+
569+
570+
- `--full-paths / --no-full-paths`
571+
572+
Show full paths instead of paths relative to the project root. Applies to both text and JSON output. [default: no-full-paths]
573+
574+
575+
- `--output-format [concise|json|json-indent|sarif|github|gitlab]`
576+
577+
Output format for the analysis result. Overrides the global `--format` for this command. `concise` (default) is the human-readable text output; `sarif` emits a SARIF 2.1.0 log; `github` emits GitHub Actions workflow annotations; `gitlab` emits a GitLab Code Quality report.
578+
579+
580+
- `--output-file FILE`
581+
582+
Write the report to FILE instead of stdout. Useful with `--output-format sarif`/`gitlab` to produce an artifact for CI upload.
583+
584+
555585
- `--help`
556586

557587
Show this message and exit.

0 commit comments

Comments
 (0)