Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Formats all Robot Framework files recursively in the current directory, overwriting them. For specific files or directories, replace '.' with the target paths (e.g., `robotidy tests/ test.robot`).
robotidy .
robotidy --version
Debug
Known issues
deprecatedThe standalone `robotframework-tidy` tool is deprecated since version 4.17.0. New users and projects are strongly encouraged to use the formatter built into `robotframework-robocop` (version 6.0+). The standalone version may not support the latest Robot Framework features or receive active development in the future.fixMigrate to `robotframework-robocop` and use its `robocop format` command. Install with `pip install robotframework-robocop`.
affects: >=4.17.0
gotchaAlthough `robotframework-tidy` dependencies are now 'opened up' to allow installation with newer Robot Framework versions, the standalone tool's compatibility with very recent Robot Framework releases (especially post-RF 7.0) is not guaranteed due to its deprecated status.fixFor best compatibility with the latest Robot Framework versions, use the `robocop format` command from `robotframework-robocop`.
affects: >=4.17.0
gotchaWhen running Robotidy in Continuous Integration (CI) pipelines, it's crucial to use the `--check` flag. This flag makes Robotidy return a non-zero exit code if any files would have been modified, preventing unformatted code from being merged.fixInclude `robotidy --check .` in your CI pipeline instead of just `robotidy .`.
affects: All
gotchaOlder Robot Framework versions (e.g., 4.x and below) do not support modern syntax elements like `BREAK`, `RETURN`, or the `VAR` statement. While `robotframework-tidy` versions 4.10.0+ added support for `VAR` syntax and 4.16.0+ for `GROUP`s (for Robot Framework 7.0+), applying such transformations on older Robot Framework installations will lead to syntax errors.fixEnsure your `robotframework-tidy` version is compatible with your target Robot Framework version, especially when using transformers that update to newer syntax. Consider upgrading Robot Framework to 7.0+ if using `VAR` or `GROUP` features.
affects: <4.10.0 for VAR, <4.16.0 for GROUPs
Upgrade
Version history
4.18.0latest on PyPI · released Jul 3, 2025
Audit
Dependencies
Robot FrameworkrequiredCore dependency for parsing and formatting Robot Framework code.
clickrequiredCommand-line interface toolkit.
rich-clickrequiredEnhanced command-line interface formatting.
tomlirequiredTOML parser for configuration files (Python < 3.11).
tomli-wrequiredTOML writer for configuration files.