Skip to content

Commit 5ed008f

Browse files
studio AI docs
1 parent e264503 commit 5ed008f

File tree

1 file changed

+97
-15
lines changed

1 file changed

+97
-15
lines changed

docs/app/guides/cypress-studio.mdx

Lines changed: 97 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
---
2-
title: 'Cypress Studio: Build Tests by Interacting with Your App'
3-
description: 'Create, extend, and refine Cypress tests without writing commands by hand.'
4-
sidebar_label: 'Cypress Studio'
2+
title: 'Cypress Studio AI: Build Tests by Interacting with Your App'
3+
description: 'Create, extend, and refine Cypress tests with AI-powered recommendations without writing commands by hand.'
4+
sidebar_label: 'Cypress Studio AI'
55
e2eSpecific: true
6+
sidebar_custom_props: { 'new_label': true }
67
---
78

89
<ProductHeading product="app" />
910

10-
# Cypress Studio
11+
# Cypress Studio AI
1112

1213
:::info
1314

1415
##### <Icon name="question-circle" color="#4BBFD2" /> What you'll learn
1516

1617
- How to generate Cypress tests by interacting with your app
18+
- How AI automatically suggests relevant assertions as you record
1719
- How to add assertions by right-clicking elements
1820
- How to quickly extend or edit tests without leaving Cypress
1921

@@ -24,16 +26,21 @@ e2eSpecific: true
2426
Cypress Studio turns test creation into a natural part of exploring your app.
2527
Instead of manually typing every `.get()`, `.click()`, or `.type()` command, you can **record interactions in real time**, automatically generate Cypress code, and fine-tune your test inline.
2628

29+
### Powered by AI
30+
31+
With **Cypress Studio AI**, intelligent recommendations appear automatically as you record. The AI analyzes your interactions and suggests the most relevant assertions for each step, helping you build more comprehensive tests with less effort.
32+
2733
- **Save time**: Skip manually typing `.get().click().type()` sequences
2834
- **Stay in the flow**: Build and extend tests without leaving the Cypress App
2935
- **Boost coverage**: Add new checks to existing tests in seconds
36+
- **AI-powered insights**: Get intelligent assertion recommendations as you interact with your app
3037

3138
<DocsVideo
3239
src="/img/app/cypress-studio/cypress-studio-recording-assertions-editing.mp4"
3340
autoPlay={true}
3441
/>
3542

36-
## 🚀 Quickstart: Try Studio in 60 Seconds
43+
## 🚀 Quickstart: Try Studio AI in 60 Seconds
3744

3845
:::success
3946

@@ -51,8 +58,11 @@ Instead of manually typing every `.get()`, `.click()`, or `.type()` command, you
5158
2. **Run a Spec:**
5259
Open Cypress, run a spec file, and click New Test or Edit in Studio.
5360

54-
3. **Interact & Save:**
55-
Click, type, and right-click to add assertions. Click Save to save your test.
61+
3. **Interact & Get AI Recommendations:**
62+
Click, type, and watch as AI automatically suggests relevant assertions in the Studio Panel. Accept or reject recommendations as you build your test.
63+
64+
4. **Save Your Test:**
65+
Click Save to save your test with all the AI-suggested assertions.
5666

5767
:::
5868

@@ -66,6 +76,27 @@ When Studio is enabled, you can:
6676

6777
Supported action commands include: [`.click()`](/api/commands/click), [`.type()`](/api/commands/type), [`.check()`](/api/commands/check), [`.uncheck()`](/api/commands/uncheck), [`.select()`](/api/commands/select)
6878

79+
## AI-Powered Recommendations
80+
81+
Cypress Studio AI enhances your test creation workflow by automatically analyzing your interactions and suggesting relevant assertions in real time. As you record actions, the AI appears in the Studio Panel with intelligent recommendations tailored to each step.
82+
83+
### How AI Recommendations Work
84+
85+
1. **Automatic Analysis**: As you interact with elements, the AI analyzes the context and element properties
86+
2. **Smart Suggestions**: Relevant assertions appear in the Studio Panel based on your actions
87+
3. **Accept or Reject**: Review each recommendation and choose to accept or reject it
88+
4. **Seamless Integration**: Accepted recommendations can be saved to your test file
89+
90+
### Types of AI Recommendations
91+
92+
The AI suggests assertions based on the elements you interact with:
93+
94+
- **Visibility checks**: Ensure elements are visible or hidden
95+
- **Text validation**: Verify text content matches expectations
96+
- **Form validation**: Check input values, selections, and form states
97+
- **Element properties**: Validate attributes, classes, and other properties
98+
- **Navigation confirmation**: Verify page changes and URL updates
99+
69100
### Start Studio
70101

71102
You can start Studio in several ways:
@@ -161,22 +192,73 @@ Want more control? Use the [`Cypress.ElementSelector`](/api/cypress-api/element-
161192
- Studio cannot load when running in open mode with `@cypress/grep`. You will see an error in this case. Remove any `--grep` flags from your command during `cypress open` to use Studio.
162193
- See issues labeled with [`experiment: studio`](https://github.com/cypress-io/cypress/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22experiment%3A%20studio%22) for other known issues.
163194

164-
## Coming Soon: AI in Studio
195+
:::note
165196

166-
Imagine Studio suggesting the most relevant assertions for every step you take. Cypress AI is a feature that's **coming soon** that will recommend relevant assertions in real time based on your interactions.
197+
**Studio without AI**: Cypress Studio can be used without AI features and does not require a Cloud account. You can still record interactions and manually add assertions by right-clicking elements.
198+
199+
**Studio with AI**: AI-powered recommendations require a Cypress Cloud account and provide intelligent assertion suggestions as you record.
200+
201+
:::
202+
203+
## Authentication & usage
204+
205+
Because Cypress Studio AI uses AI under the hood, it needs to communicate securely with large language models to analyze your interactions and generate relevant assertion recommendations. Cypress Cloud helps manage those requests, apply organization-level controls, and track usage in a way that's non-invasive. We never use your interactions to train AI models, and you can turn AI features off at any time. Cypress Studio AI is currently available on any of our [Cypress Cloud plan types](https://www.cypress.io/pricing).
206+
207+
**To use Cypress Studio AI, you must either:**
208+
209+
- Log into Cypress Cloud
210+
- Set up your project in Cypress Cloud
211+
212+
**If you don't have a Cloud account, create a free account and gain access to a 2-week trial of all paid features.**
167213

168214
<Btn
169-
label="Join the waitlist"
215+
label="Sign up"
170216
variant="indigo-dark"
171217
className="mr-1"
172-
href="https://go.cypress.io/studio-ai-waitlist?utm_source=docs.cypress.io&utm_medium=cypress-studio&utm_content=Join-the-waitlist"
218+
href="https://cloud.cypress.io/signup"
173219
/>
174-
175-
<DocsImage
176-
src="/img/app/cypress-studio/cypress-studio-ai-illustration.gif"
177-
alt="Cypress AI in Studio generating assertions"
220+
<Btn
221+
label="See a demo"
222+
icon="action-play-small"
223+
className="mr-1"
224+
href="https://www.youtube.com/watch?v=vFLShoCM8pA"
225+
/>
226+
<Btn
227+
label=" Explore an example project"
228+
icon="technology-terminal-log"
229+
href="https://cloud.cypress.io/projects/7s5okt"
178230
/>
179231

232+
## Pricing & usage limits
233+
234+
During the experimental release, access will be provided at no additional charge. Users are limited by the number of AI recommendations they can receive per hour. This limit is higher for paid accounts and lower for free accounts. Our intention is to not limit normal usage of the feature.
235+
236+
:::note
237+
238+
Please note that pricing and usage limitations are subject to future adjustments. We commit to keeping you informed of any such changes.
239+
240+
:::
241+
242+
### Usage limits
243+
244+
**User limits on projects with free accounts:**
245+
246+
- 60 AI recommendations per hour
247+
248+
**User limits on projects with paid accounts (or on free trial):**
249+
250+
- 300 AI recommendations per hour
251+
252+
## Privacy & security
253+
254+
For detailed information about how Cypress protects your data and manages AI model security, see our [Security & Compliance page](https://www.cypress.io/security).
255+
256+
## Disabling AI features
257+
258+
AI capabilities, including Cypress Studio AI, are enabled by default for all users on any Cloud plan. Organization admins and owners can enable and disable the AI capabilities for their entire organization from their organization settings. For more information, see [our FAQ](/cloud/faq#Are-all-Cloud-AI-capabilities-enabled-by-default-How-can-I-turn-them-off).
259+
260+
You can also disable Studio AI locally in the Cypress App by toggling off the AI feature in the Studio panel.
261+
180262
## See also
181263

182264
- [Element Selector API](/api/cypress-api/element-selector-api)

0 commit comments

Comments
 (0)