Quick Start

Getting started with Wallaby is as simple as installing the Wallaby extension for VS Code and starting Wallaby. Wallaby automatically detects your project’s test framework (pytest or unittest) and starts running your tests — no configuration required.

Before you start

Before you start using Wallaby, we recommend first double-checking that your tests are passing outside of Wallaby (e.g. by running pytest or python -m unittest from the terminal).

Starting Wallaby

To start Wallaby in VS Code, run the Select Configuration command and then select Automatic Configuration <project directory>. After that you can use the Wallaby Start command as usual and it will start Wallaby with automatic configuration.

Wallaby will automatically detect whether your project uses pytest or unittest and start running your tests.

Try the Playground

A great way to explore Wallaby’s features is the built-in playground. Run the Wallaby.py: Open Playground command from the VS Code Command Palette to open a small self-contained project where you can experiment with real-time feedback, code coverage, and other Wallaby features without affecting your own code.

Configuration

Most projects work out of the box with automatic configuration. If your project has a non-standard test setup or you need to customize Wallaby’s behavior, you can create a configuration file in your project root. See the Configuration section for more details.