Getting Started

RobotCode is a set of tools, extensions and plugins for working with Robot Framework in different IDEs, editors and on the command line. Check the requirements, set RobotCode up in your editor, then configure your project with a robot.toml file.

Requirements

• Python 3.10 or above, in a version that your Robot Framework version supports; Python 3.15, for example, is supported from Robot Framework 7.5 on
• Robot Framework 5.0 or above
• For the editor extensions: VS Code 1.127 or above, or PyCharm / IntelliJ IDEA 2026.1 or above

Optional Python Packages

Robot Framework needs additional Python packages for some documentation formats. They are optional in Robot Framework, so RobotCode neither depends on them nor ships them. If you need one of them, install it into the Python environment of your project, the same way you install Robot Framework itself, for example by adding it to the dependencies of your project.

Package	Needed for	Without it
docutils	Libraries that write their documentation in reStructuredText (ROBOT_LIBRARY_DOC_FORMAT = "reST"), and everything else Robot Framework does with reStructuredText	RobotCode shows the documentation of such libraries as plain reStructuredText source instead of formatted text
markdown (Python-Markdown)	The HTML documentation of libraries that write their documentation in Markdown: "Open Documentation (deprecated)" in the editor, "Show Documentation (deprecated)" in the Keywords view and robotcode libdoc. Since Robot Framework 7.5 this includes the standard libraries such as BuiltIn and Collections. robotcode doc and the Documentation Viewer do not need it	"Open Documentation (deprecated)" shows Robot Framework's message that the markdown module is missing. Hover and completion are not affected

See the Robot Framework User Guide for details about these formats.

Set up RobotCode

The pages below set RobotCode up in VS Code, PyCharm or IntelliJ IDEA, and Neovim, and configure your project:

Get Started with VS CodeInstall the RobotCode extension for VS Code, set up a Python virtual environment with Robot Framework, select the interpreter and run your first test.

Get Started with PyCharmInstall the RobotCode plugin in PyCharm or IntelliJ IDEA, set up a Python interpreter with Robot Framework and run your first test.

Configuring RobotCode as Language Server for NeovimUse the RobotCode language server in Neovim 0.11+ without Mason import errors, via a project-local install or a global install with PYTHONPATH set.

Try the Dev BuildsGet the dev builds of RobotCode for VS Code, PyCharm and the command line, recognize their versions and go back to the releases.

Configure Your ProjectCreate a robot.toml for your Robot Framework project: a first configuration, running the tests with it, a profile for another environment and personal settings.