Guides

The guides explain how to work with RobotCode in VS Code and PyCharm and with RobotCode's commands, how to set up a project, and practices for writing Robot Framework code with RobotCode. Have a guide or a tip to share? See Support & Contribute.

Working in VS CodeWhere RobotCode shows up in the VS Code window, the commands it adds, and where to read more about each task.

Working in PyCharmWhere RobotCode shows up in PyCharm and IntelliJ IDEA, the actions it adds, what it does not offer there yet, and where to read more about each task.

Discovering Tests, Tasks and SuitesList the suites, tests, tasks, tags and source files Robot Framework would pick up with robotcode discover, without running anything, as a tree or as JSON.

Analyzing CodeRun static analysis with robotcode analyze code, tune severities and exit codes, and produce JSON, SARIF, GitHub or GitLab reports for CI pipelines.

Analyzing Run ResultsSummarize, list, walk, aggregate and diff Robot Framework run results with robotcode results in the terminal or CI, using filters, search and JSON output.

Interactive Robot Framework with robotcode replCall Robot Framework keywords line by line in robotcode repl: import libraries, keep variables across lines, run REPL scripts, capture a log and debug.

Command-line debugging with robotcode robot-debugDebug Robot Framework suites in the terminal with robotcode robot-debug: break on a line, keyword or failure, step, and inspect the stack and variables.

Browsing Library DocumentationShow the documentation of a library, resource file or suite file with robotcode doc, as Markdown, as JSON or in a terminal viewer, with the project's configuration.

Configuring Projects with robot.tomlWhat robot.toml is for, who reads it, an example project that the pages of this guide build on, and what the editors take from it.

Running Tests Through a WrapperRun tests through a wrapper command like xvfb-run or your own script, set in robot.toml or on the CLI, to bring the test environment up and tear it down.

Excluding Files with .robotignoreKeep build output, dependencies and other folders out of discovery, analysis and the language server using gitignore-style patterns in .robotignore.

Working with AI AgentsSet up the RobotCode chat plugin for Copilot Chat, Claude Code and other agents so they run, discover, debug and inspect tests via the robotcode CLI.

Avoiding a Global Resource FileWhy one catch-all resource file causes circular imports, ambiguous keywords and slow analysis, how to modularize it, and how to suppress the warnings.

Why is my variable shown as "not found"?Why RobotCode's static analysis flags VariableNotFound for variables that work at runtime, and how Variables sections, defaults and RETURN avoid it.

Customizing Robot Framework Highlighting in VS CodeRobotCode sets font styles for Robot Framework keywords, test case names, section headers and documentation in VS Code; change them with token color rules in settings.json.