You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "Install the QIT plugin for Claude Code to get AI-powered test creation, debugging, and quality automation. For other AI assistants, use the QIT documentation index at llms.txt to provide context."
2
+
description: "Deep dive into AI-powered QIT workflows: what Claude can do with the QIT plugin, how progressive disclosure works, and the structured methodology for creating test packages with AI agents."
3
3
---
4
4
5
5
# AI-Assisted Development
6
6
7
-
QIT integrates with AI assistants to help you develop test packages, debug failures, and automate quality workflows.
7
+
:::info Prerequisites
8
+
This page assumes your AI agent already has QIT context. If not, see [Getting Started](../getting-started.md) to install the Claude Code plugin or point your agent to llms.txt.
9
+
:::
8
10
9
-
## Claude Code Plugin (Recommended)
11
+
Once set up, your AI agent can handle any QIT task autonomously. This page covers what's possible and how to get the most out of it.
10
12
11
-
The QIT CLI ships as a **Claude Code plugin**. Once installed, Claude can handle any QIT task autonomously. It fetches live documentation, runs commands, creates test packages, and debugs failures without you needing to provide manual context.
12
-
13
-
### Install
14
-
15
-
In Claude Code, run:
16
-
17
-
```
18
-
/plugin marketplace add woocommerce/qit-cli
19
-
/plugin install qit@woocommerce-qit
20
-
```
21
-
22
-
That's it. Claude now has QIT expertise. Try asking:
23
-
24
-
- "Run a security scan on my plugin"
25
-
- "Create E2E tests for this extension"
26
-
- "My QIT tests are failing, help me debug"
27
-
- "Set up qit.json for this project"
28
-
- "What test packages are available for cross-compatibility testing?"
29
-
30
-
### How It Works
31
-
32
-
The plugin provides a skill that uses **progressive disclosure** from QIT's live documentation:
33
-
34
-
1. Claude fetches the [documentation index](https://qit.woo.com/docs/llms.txt) to find relevant pages
35
-
2. It reads the specific docs needed for your task
36
-
3. It acts on what it learned: running commands, writing code, interpreting results
37
-
38
-
This means Claude always has current information, even as QIT evolves.
39
-
40
-
### What Claude Can Do
13
+
## What Claude Can Do
41
14
42
15
With the QIT plugin, Claude can:
43
16
@@ -48,13 +21,12 @@ With the QIT plugin, Claude can:
48
21
-**Manage environments**: start, stop, and interact with Docker test environments
49
22
-**Publish packages**: validate and publish test packages to the QIT registry
50
23
51
-
---
24
+
## How It Works
52
25
53
-
## Other AI Assistants
26
+
The plugin uses **progressive disclosure** from QIT's live documentation:
54
27
55
-
If you're using GPT-4, GitHub Copilot, or another AI assistant, QIT provides two machine-readable documentation files you can feed to your AI:
56
-
57
-
-**[llms.txt](https://qit.woo.com/docs/llms.txt)**: Documentation index with descriptions. Feed this to your AI and ask it to fetch the pages relevant to your task.
58
-
-**[llms-full.txt](https://qit.woo.com/docs/llms-full.txt)**: Complete documentation in a single file. Use when your AI can accept large context.
28
+
1. Claude fetches the [documentation index](https://qit.woo.com/docs/llms.txt) to find relevant pages
29
+
2. It reads the specific docs needed for your task
30
+
3. It acts on what it learned: running commands, writing code, interpreting results
59
31
60
-
These follow the [llmstxt.org](https://llmstxt.org) standard and contain the same documentation that the Claude Code plugin accesses.
32
+
This means Claude always has current information, even as QIT evolves. You don't need to paste docs or explain QIT concepts — the agent discovers what it needs on-demand.
Copy file name to clipboardExpand all lines: docs/getting-started.md
+45-25Lines changed: 45 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,48 @@
1
1
---
2
2
sidebar_position: 2
3
-
description: "Step-by-step setup guide: install QIT CLI via Composer, authenticate with WooCommerce.com using `qit connect`, and run your first test with `qit run:security`. Includes troubleshooting for PATH issues and authentication problems. Links to managed tests, test packages, and configuration as next steps."
3
+
description: "Get started with QIT — let your AI coding agent handle installation, authentication, and testing, or run the CLI commands yourself. Same tool, you choose who drives."
4
4
---
5
5
6
6
# Getting Started
7
7
8
-
## Installation
8
+
QIT is a CLI that runs automated quality tests on WooCommerce extensions. Your AI coding agent can drive it for you, or you can run the commands yourself.
9
9
10
-
Install QIT CLI globally with Composer:
10
+
## Let Your AI Agent Drive (Recommended)
11
+
12
+
Point your AI agent to QIT's documentation and ask it to handle the rest — installation, authentication, running tests, everything.
13
+
14
+
**Claude Code** — install the plugin for automatic discovery:
15
+
16
+
```
17
+
/plugin marketplace add woocommerce/qit-cli
18
+
/plugin install qit@woocommerce-qit
19
+
```
20
+
21
+
**Any other AI agent** — give it the documentation URL:
22
+
23
+
> Read https://qit.woo.com/docs/llms.txt — I want to test my WooCommerce extension with QIT.
24
+
25
+
Then just ask what you need:
26
+
27
+
-*"Install QIT and run a security scan on my-plugin"*
28
+
-*"Create E2E tests for this extension"*
29
+
-*"My QIT tests are failing, help me debug"*
30
+
-*"Set up qit.json for this project"*
31
+
32
+
Learn more about AI workflows in [AI-Assisted Development](./ai/getting-started.md).
33
+
34
+
---
35
+
36
+
## The CLI
37
+
38
+
Whether you or your agent is typing these commands, this is how QIT works.
39
+
40
+
### Installation
11
41
12
42
```bash
13
43
composer global require "woocommerce/qit-cli:*"
14
44
```
15
45
16
-
Verify the installation:
17
-
18
46
```bash
19
47
qit --version
20
48
```
@@ -43,26 +71,14 @@ After updating your PATH, open a new terminal window or reload your shell config
43
71
44
72
</details>
45
73
46
-
## Updating the QIT CLI
47
-
48
-
Update to the latest version:
49
-
50
-
```bash
51
-
composer global update woocommerce/qit-cli
52
-
```
53
-
54
-
## Authentication
55
-
56
-
Connect QIT to your WooCommerce.com account:
74
+
### Authentication
57
75
58
76
```bash
59
77
qit connect
60
78
```
61
79
62
80
This opens your browser for authentication. Complete the flow and return to your terminal.
63
81
64
-
Verify authentication:
65
-
66
82
```bash
67
83
qit extensions
68
84
```
@@ -78,42 +94,46 @@ If still having issues, contact qit@woocommerce.com with your partner account em
78
94
79
95
</details>
80
96
81
-
## Run Your First Test
82
-
83
-
Run a security scan. It works in the cloud with no local setup:
97
+
### Running Tests
84
98
85
99
```bash
86
100
qit run:security your-extension-slug
87
101
```
88
102
89
103
Replace `your-extension-slug` with the slug shown in `qit extensions` output.
90
104
91
-
You'll see results in your terminal. To test a local development build instead of the marketplace version:
105
+
Test a local build instead of the marketplace version:
Every command has detailed help showing all available options:
119
+
Every command has detailed help:
106
120
107
121
```bash
108
122
qit run:security --help
109
123
```
110
124
125
+
### Updating
126
+
127
+
```bash
128
+
composer global update woocommerce/qit-cli
129
+
```
130
+
111
131
## What's Next?
112
132
133
+
-**[AI-Assisted Development](./ai/getting-started.md)**: Deep dive into AI-powered test creation, debugging, and the structured methodology for writing test packages with agents.
113
134
-**[Managed Tests](./managed-tests/introduction.md)**: Learn what each test checks and how to interpret results.
114
135
-**[Test Packages](./test-packages/index.md)**: Write custom E2E tests for your plugin and test compatibility with other plugins. Requires Docker.
115
136
-**[Configuration](./configuration/index.md)**: Save your test settings in `qit.json` so you don't retype them.
116
-
-**[AI-Assisted Development](/ai/getting-started/)**: Use QIT with Claude Code for AI-powered test development and debugging.
description: "Overview of QIT (Quality Insights Toolkit), a quality assurance platform for the WordPress ecosystem. Explains the two testing approaches: managed tests (pre-built checks like security, activation, PHPStan that run remotely with zero setup) and test packages (custom Playwright E2E tests that run locally with Docker for cross-plugin compatibility testing). Covers who QIT is for (WooCommerce.com Marketplace developers) and links to Getting Started."
4
+
hide_table_of_contents: true
5
+
hide_title: true
6
+
pagination_next: null
7
+
title: "QIT: Quality Insights Toolkit"
8
+
description: "QIT (Quality Insights Toolkit) is an automated testing platform for WooCommerce extensions. The official quality gateway for the WooCommerce.com Marketplace, built by Automattic. AI-first: let your coding agent drive the CLI."
Automated testing infrastructure for WooCommerce extensions.<br />
14
+
The official quality gateway for the <strong>WooCommerce.com Marketplace</strong>.
15
+
</p>
8
16
9
-
QIT is a quality assurance platform for the WordPress ecosystem. It provides the testing infrastructure that helps developers ship reliable extensions and helps marketplaces maintain quality standards.
10
-
11
-
## The Quality Challenge
12
-
13
-
WordPress powers 40% of the web through its extensibility. The average WordPress site runs dozens of plugins from different developers, each updated on their own schedule. This creates a quality assurance challenge:
14
-
15
-
- Developers can't test with every possible plugin combination
16
-
- Marketplaces need consistent quality standards
17
-
- Users need reliability when combining extensions
18
-
- The ecosystem needs shared testing infrastructure
19
-
20
-
QIT addresses these challenges by providing standardized testing tools that work across the WordPress ecosystem.
21
-
22
-
## QIT as a Quality Gateway
23
-
24
-
QIT addresses these challenges by acting as a quality gateway between developers and trusted marketplaces. Every extension passes through automated quality checks before reaching users.
When a developer publishes an extension, QIT automatically validates quality through comprehensive testing before it reaches users. This gateway ensures every extension in trusted marketplaces meets consistent quality standards.
54
-
55
-
## Two Testing Approaches
56
-
57
-
### Managed Tests
58
-
59
-
Industry-standard quality checks packaged to work consistently across all extensions. These automated tests run with zero setup in development, CI pipelines, and as marketplace quality gates.
60
-
61
-
Whether you're testing locally, automating in GitHub Actions, or publishing to a marketplace, managed tests provide the same comprehensive validation - ensuring extensions meet security, compatibility, and functionality standards before reaching production sites.
62
-
63
-
### Test Packages
64
-
65
-
While managed tests ensure baseline quality, Test Packages solve a deeper problem: **custom plugin behavior and cross-plugin compatibility**.
66
-
67
-
Test Packages are E2E tests built on Playwright that follow a standardized format, enabling them to be combined and run together. This standardization is what makes cross-compatibility testing possible and allows Test Packages to serve as quality gates alongside managed tests.
68
-
69
-
Developers can:
70
-
- Test their plugin's specific features and custom behavior
71
-
- Verify compatibility between multiple plugins
72
-
- Combine multiple test packages in a single run
73
-
- Share tests so others can validate compatibility with their plugin
74
-
75
-
```bash
76
-
# Example: Combine multiple test packages to verify cross-plugin compatibility
This is crucial: developers can test **how their plugin actually behaves with other real plugins**, not just in isolation. When payment gateways share their checkout tests, when shipping providers share their calculation tests, when subscription plugins share their renewal tests - the entire ecosystem becomes more reliable.
85
-
86
-
## Current Availability
87
-
88
-
QIT is currently available to WooCommerce.com Marketplace developers. We're actively working to expand access to extensions outside the WooCommerce Marketplace, making quality infrastructure available to the broader WordPress ecosystem.
89
-
90
-
## Next Steps
44
+
<divclassName="qit-grid">
45
+
<divclassName="qit-card">
46
+
<div className="qit-card-icon">🛡️</div>
47
+
<h3>Managed Tests</h3>
48
+
<p>10 automated checks (security, compatibility, performance, static analysis) that run with zero setup. Same checks locally, in CI, and at the marketplace gate.</p>
49
+
</div>
50
+
<divclassName="qit-card">
51
+
<div className="qit-card-icon">🧩</div>
52
+
<h3>Test Packages</h3>
53
+
<p>Playwright-based E2E tests in a standardized format. Combine packages from different plugins in one run to verify cross-plugin compatibility.</p>
54
+
</div>
55
+
<divclassName="qit-card">
56
+
<div className="qit-card-icon">🐳</div>
57
+
<h3>Local Environment</h3>
58
+
<p>Sandboxed, Alpine-based Docker environments optimized for CI and automated testing. Spin up, test, tear down.</p>
59
+
</div>
60
+
<divclassName="qit-card">
61
+
<div className="qit-card-icon">⚙️</div>
62
+
<h3>CI-Ready</h3>
63
+
<p>Single CLI that works the same everywhere. Run the full suite in GitHub Actions with <code>qit run</code>. Same commands, same results.</p>
64
+
</div>
65
+
</div>
91
66
92
-
Ready to start using QIT? Learn how to install, authenticate, and run your first tests.
67
+
<divclassName="qit-ai-banner">
68
+
<divclassName="qit-ai-banner-icon">🤖</div>
69
+
<div>
70
+
<h3>AI-First</h3>
71
+
<p>
72
+
QIT is a CLI designed to be driven by your AI coding agent. Install the <strong>Claude Code</strong> plugin and your agent gets full QIT expertise: running tests, creating test packages, debugging failures, and configuring projects.
0 commit comments