Skip to content

coders-tm/laravel-core / .agents/skills/testbench-docs

testbench-package-testing

Verified

Develops and tests Laravel packages using Orchestra Testbench. Activates when writing package tests, configuring testbench.yaml, managing migrations, defining routes/environment for tests, using Testbench Dusk for browser tests, or working with Workbench for package preview.

getting-started.md

View on GitHub
---
next:
  text: 'Configuration'
  link: '/getting-started/configuration'
---

# Introduction

Packages Toolkit for Laravel is a collection of packages that have been designed to write, test, and preview your Laravel packages.

Before going through the rest of this documentation, please take some time to read the [Package Development](https://laravel.com/docs/packages) section of Laravel's own documentation, if you haven't done so yet.

[[toc]]

## Installation

To start using Packages Toolkit for Laravel you can first install the components:

```bash
composer require --dev "orchestra/testbench"
```

Alternatively, if you need to run Dusk tests on your Laravel package you should install the following dependency instead:

```bash
composer require --dev "orchestra/testbench-dusk"
```

### Setup

Next, you can run the following command to scaffold your package with the recommended setup:

```bash
vendor/bin/testbench workbench:install
```

## Components

### Testbench

Testbench simplifies the process of creating feature and integration tests for your Laravel packages without massive configuration and build steps. 

##### Version Compatibility

 Laravel  | Testbench | Recommended Versions
:---------|:----------|:----------
 8.x      | 6.x       | `^6.45`
 9.x      | 7.x       | `^7.50`
 10.x     | 8.x       | `^8.31`
 11.x     | 9.x       | `^9.9`
 12.x     | 10.x      | `^10.0`

### Testbench Dusk

Testbench Dusk is built on top of Testbench to provide support running browser-based tests for your Laravel packages using [Laravel Dusk](https://laravel.com/docs/dusk). 

##### Version Compatibility

 Laravel  | Testbench Dusk | Recommended Versions
:---------|:---------------|:----------
 8.x      | 6.x            | `^6.50`
 9.x      | 7.x            | `^7.51`
 10.x     | 8.x            | `^8.33`
 11.x     | 9.x            | `^9.11`
 12.x     | 10.x           | `^10.0`

### Testbench Core

Testbench Core provides the full testing API and CLI `testbench` binary which is being used by **Testbench**, **Testbench Dusk**, and **Workbench**. This component is accessible via `orchestra/testbench` without any further requirements.

##### Version Compatibility

 Laravel  | Testbench Core   
:---------|:-----------
 8.x      | 6.x
 9.x      | 7.x
 10.x     | 8.x
 11.x     | 9.x
 12.x     | 10.x

### Canvas

Canvas replicates all of the `make` artisan commands available in your basic Laravel application to speed up your Laravel package development.

##### Version Compatibility

 Laravel  | Canvas   | Recommended Versions
:---------|:---------|:----------
 8.x      | 6.x      | `^6.10`
 9.x      | 7.x      | `^7.12`
 10.x     | 8.x      | `^8.12`
 11.x     | 9.x      | `^9.2`
 12.x     | 10.x     | `^10.0`

### Workbench

Workbench provides a set of configurable actions and commands to allow previewing, interacting, and serving your Laravel packages during development. This component is accessible via `orchestra/testbench` without any further requirements.

##### Version Compatibility

 Laravel  | Workbench | Recommended Versions
:---------|:----------|:----------
 8.x      | -         | -
 9.x      | 7.x       | `^7.17`
 10.x     | 8.x       | `^8.17`
 11.x     | 9.x       | `^9.13`
finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the workStars: 322kUpdated Claude CodeCodexVerifiedInstall
systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixesStars: 322kUpdated Claude CodeCodexVerifiedInstall
test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation codeStars: 322kUpdated Claude CodeCodexVerifiedInstall
skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.Stars: 197kUpdated Claude CodeCodexVerifiedInstall