Repository files navigation

RobotCode is a comprehensive toolkit for Robot Framework development, offering advanced features to enhance your productivity and streamline your workflow. Whether you're using Visual Studio Code, IntelliJ, or other LSP-compatible editors, RobotCode ensures a consistent and seamless experience.

• Built on Robot Framework CoreRobotCode uses Robot Framework's native parser for syntax validation, error messages, and behavior, ensuring full compatibility and reliability in your projects.

• Powered by the Language Server Protocol (LSP)By leveraging the LSP, RobotCode provides real-time code navigation, intelligent auto-completion, and refactoring capabilities across various editors and IDEs.

• Multi-Platform IDE ExtensionsRobotCode offers robust extensions for Visual Studio Code and IntelliJ Platform, delivering the same high-quality features regardless of your preferred development environment. Thanks to LSP, it also works with editors like Neovim and Sublime Text.

• Enhanced CLI ToolsExtend Robot Framework's command-line capabilities with tools for test execution, debugging, and code analysis. Features includerobot.toml support, a Debug Adapter Protocol (DAP) debugger, and an interactive REPL for quick experimentation.

With RobotCode, you can focus on building and testing your automation workflows while enjoying an integrated and efficient development experience.

• Code Editing: Enjoy code auto-completion, navigation and more.
• IntelliSense: Get code completion suggestions for keywords, variables, and more.
• Refactoring: Rename variables, keywords, arguments and more with ease and project wide.
• Enhanced Syntax Highlighting: Easily identify and read your Robot Framework code with support highlight embedded arguments, python expressions, environment variables with default values, and more.
• Code Snippets: Quickly insert common Robot Framework code snippets.
• Test Discovery: Discover and run Robot Framework test cases directly within VS Code.
• Test Execution: Execute Robot Framework test cases and suites directly within VS Code.
• Test Reports: View test reports directly within VS Code.
• Debugging: Debug your Robot Framework tests with ease.
• Command Line Tools: A wide array of tools to assist in setting up and managing Robot Framework environments.
• Code Analysis with Robocop: InstallRobocop for additional code analysis.
• Code Formatting: Format your code using Robot Framework’s built-in tools likerobot.tidy orRobotidy.
• Multi-root Workspace Support: Manage multiple Robot Framework projects with different Python environments simultaneously.
• Customizable Settings: Configure the extension to fit your needs.
• RobotCode Repl and Notebooks: Play with Robot Framework in a Jupyter Notebook-like environment.
• And More!: Check out theofficial documentation for more details.

• Python 3.10 or newer
• Robot Framework 5.0 or newer

• Visual Studio Code 1.99 or newer
• PyCharm 2025.1 or newer or IntelliJ IDEA 2025.1 or newer

⚠️ DEPRECATION WARNING:Support for Python 3.8, 3.9, and Robot Framework 4.1 is deprecated and will be removed in a future release. To ensure compatibility and benefit from ongoing improvements, please upgrade to Python 3.10 or later and Robot Framework 5.0 or later.

Python Version Requirements:Although Robot Framework still supports Python 3.8 and 3.9, RobotCode requires Python 3.10 or newer due to its use of more modern libraries and features. Many key tools in the ecosystem—such as robocop and the Browser library—have already dropped support for Python 3.8, which is no longer maintained. Python 3.9 will reach end-of-life on October 5, 2025.

Robot Framework Version Requirements:Robot Framework 4.1 is outdated. Given the regular release cadence of Robot Framework—typically two major versions per year—maintaining support for older versions introduces significant overhead. That effort is better spent on supporting current and upcoming features.

Compatibility and Limitations:RobotCode currently remains compatible with Python 3.8+ and Robot Framework 4.1+, but with important limitations:•New features may not be available for older versions.•Development and testing efforts are focused on newer versions.

Why Python 3.10:After Python 3.9 reaches end-of-life, RobotCode will start using Python 3.10+ features that are not backward-compatible. Python 3.10 introduces several important improvements, including:•Structural pattern matching•More informative error messages•Simplified type hints using the | operator•Performance enhancements

These capabilities enable cleaner, more efficient code and improved developer experience.

Recommendation:To get the most out of RobotCode, we recommend using:•Python 3.10 or newer•Robot Framework 5.0 or newer

1. Install the RobotCode ExtensionOpen theVisual Studio Marketplace and install the RobotCode extension.

2. Set Up Your EnvironmentConfigure your Robot Framework environment using the tools and commands provided by the extension or therobot.toml file.

3. Start TestingBegin writing and running your Robot Framework tests directly in VS Code.

4. Explore MoreVisit theGetting Started Guide for detailed setup instructions and advanced features.

Extensions:RobotCode automatically installs thePython and thePython Debugger extension. Additional extensions may be required depending on your project needs.

1. Install the RobotCode PluginChoose one of the following methods to install the RobotCode plugin in your IDE:

   • Install via the Built-in Plugin MarketplaceNavigate to:Settings/Preferences >Plugins >Marketplace > Search for "RobotCode" and clickInstall.

   • Use the JetBrains MarketplaceAlternatively, install the plugin directly from theJetBrains Marketplace. Click theInstall to ... button if your IDE is running.

   • Manual InstallationDownload thelatest release and install it manually:Settings/Preferences >Plugins >⚙️ >Install plugin from disk....

2. Set Up Your EnvironmentConfigure your Robot Framework environment using the tools and commands provided by the plugin or therobot.toml file.

3. Start TestingBegin developing and executing your Robot Framework tests.

4. Explore MoreVisit theGetting Started Guide for detailed setup instructions and advanced features.

Plugins:RobotCode automatically installs theLSP4IJ. Additional plugins may be required depending on your project needs.

For detailed instructions, visit ourofficial documentation.Here are some additional resources to help you troubleshoot or learn more:

• Q&A: Answers to common questions about RobotCode.
• Troubleshooting Guide: Solutions for setup issues, performance problems, and debugging errors.
• Command Line Tools Reference: Comprehensive documentation on using RobotCode’s CLI tools.
• Changelog: Track changes, updates, and new features in each release.
• Support: Learn how to get help and report issues.

This project is licensed under theApache 2.0 License.