What are Cypress custom commands?

Cypress custom commands are reusable commands added to the Cypress command chain. Teams use them for repeated actions such as login, data setup, selecting stable elements, API helpers, and common workflows that appear across many specs.

Where do Cypress custom commands go?

Most projects define custom commands in cypress/support/commands.js or cypress/support/commands.ts and load them from the support file. Larger projects may split commands by domain and import them from the central support entry.

Should I put assertions in Cypress custom commands?

Put small setup assertions in commands when they prove the command succeeded, but avoid hiding the main test assertion. The spec should still clearly show the behavior being verified so failures are easy to understand.

How do I type Cypress custom commands in TypeScript?

Add declarations for the Cypress.Chainable interface, usually in a support type file. The command implementation and the type declaration should agree on parameters and return subject so autocomplete and compile checks stay useful.

Can custom commands make Cypress tests flaky?

Yes, if they hide waits, share state, depend on unstable selectors, or combine too many actions. Good commands reduce flakiness by standardizing reliable setup. Poor commands make failures harder to trace.

Cypress Custom Commands: Reusable Test Actions

cypress custom commands is not just a tool topic. It is a practical way to reduce release risk when extracting repeated Cypress actions without hiding the test purpose. Teams usually search for this when a test suite is becoming slower, less trustworthy, or harder to explain during review.

This guide follows the same field style as the core QA guides: clear preconditions, concrete examples, comparison tables, common mistakes, and a workflow you can apply on a real project. You will see where Cypress.Commands.add, support files, chainable return values, TypeScript declarations, API setup helpers, and selector commands fit, how to choose the right level of detail, and how to avoid fragile coverage.

Cypress Custom Commands That Stay Maintainable

The goal of cypress custom commands is to make testing more repeatable without making it more mysterious. A good test should reveal its setup, action, expected result, and reason for existing. The reader should not need private knowledge of the framework to understand what product behavior is protected.

Use this guide with the related automation and manual testing material in the QABattle library. For broader framework decisions, read Selenium vs Playwright vs Cypress. For test design foundations, keep how to write test cases nearby because tool fluency does not replace clear expected results.

Where This Fits in a QA Strategy

This topic sits between product risk and execution mechanics. Product risk tells you what must be protected. Execution mechanics tell you how the check runs. Weak teams jump straight to code or checklist rows. Strong teams first decide what evidence the test should produce and why that evidence matters.

The right scope depends on the test level. Some behavior belongs in unit tests, API tests, component tests, or manual exploratory sessions. Use cypress custom commands when it gives better evidence than a lower level check and when the cost of maintaining it is justified by the risk.

This also affects review. A reviewer should ask whether the test is stable, readable, isolated, and valuable. If the test only proves that a script can click through a screen, it needs sharper assertions. If it depends on hidden state, it needs clearer setup.

Concepts and Tradeoffs

Command pattern	Good fit	Warning sign
cy.loginByApi	Fast authenticated setup	The command is used to test the login screen
cy.getByTestId	Stable element hooks for complex components	Every element gets a hook without review
cy.createOrder	API setup with unique data	Shared data is mutated by several specs
cy.fillAddressForm	Repeated component interaction	Validation behavior is hidden
cy.assertToast	Common notification check	The command swallows failures or waits by time

Use this table as a decision aid. It is normal for a real project to have exceptions. Legacy systems, platform limits, shared environments, and short release windows all create compromises. The important thing is to make the compromise explicit so the team can improve it later.

When a suite grows, the best design is usually boring. Names are clear, data is controlled, setup is near the test or in a well named helper, and assertions describe product behavior. Boring structure is a strength because it lets failures point at the product instead of the framework.

Practical Example

The example below is intentionally small. It shows the shape of the work without pretending to be a full framework. Replace the URLs, data, identifiers, and assertions with your application contract. Keep the behavior visible even when you extract helpers later.

Cypress.Commands.add('getByTestId', (id) => {
  return cy.get('[data-testid="' + id + '"]');
});

Cypress.Commands.add('loginByApi', (email, password) => {
  cy.request('POST', '/api/auth/login', { email, password }).then((response) => {
    expect(response.status).to.eq(200);
    window.localStorage.setItem('authToken', response.body.token);
  });
});

cy.loginByApi('buyer@example.com', 'ValidPass#2026');
cy.visit('/checkout');
cy.getByTestId('checkout-submit').click();

Do not stop at making the example pass once. Run it in the same conditions that matter for your team: CI, parallel execution, a clean environment, realistic data, and the supported browser or device mix. If the test fails only under load or only in CI, investigate state, synchronization, and environment assumptions before blaming the tool.

Step-by-Step Workflow

Step 1: Extract only after repetition is real

Extract only after repetition is real is a concrete design decision, not a slogan. Write down what the test receives, what action it performs, what the expected result is, and what should happen when the expected state is missing. This keeps the test useful when another tester reads it months later.

Make the risk visible, keep the setup controlled, and assert the result a user or stakeholder would care about. A test that only repeats clicks is not enough. The value comes from the decision it supports during release, triage, or regression review. In this context, the choice should reduce ambiguity. If it adds a helper, command, fixture, locator, keyword, device, or data setup, the name should explain the purpose without forcing every reviewer to inspect the implementation.

Step 2: Keep commands at the right level

Keep commands at the right level is a concrete design decision, not a slogan. Write down what the test receives, what action it performs, what the expected result is, and what should happen when the expected state is missing. This keeps the test useful when another tester reads it months later.

Step 3: Make parameters explicit

Make parameters explicit is a concrete design decision, not a slogan. Write down what the test receives, what action it performs, what the expected result is, and what should happen when the expected state is missing. This keeps the test useful when another tester reads it months later.

Step 4: Return useful chain subjects or ids

Return useful chain subjects or ids is a concrete design decision, not a slogan. Write down what the test receives, what action it performs, what the expected result is, and what should happen when the expected state is missing. This keeps the test useful when another tester reads it months later.

Step 5: Name commands by intent and path

Name commands by intent and path is a concrete design decision, not a slogan. Write down what the test receives, what action it performs, what the expected result is, and what should happen when the expected state is missing. This keeps the test useful when another tester reads it months later.

Test Data and State Control

Most unstable testing work has a state problem. The account is shared. The record was changed by another test. The mobile app still has cached data. The browser session reused an old token. The fixture cleaned up only when the test passed. Treat state as part of the test case.

For each important scenario, define role, permissions, feature flags, locale, platform, version, network assumptions, seeded records, and cleanup. If a helper creates data, return the identifier and attach it to the report. If a record is shared, keep it read only or reset it before every run.

Separate regression data from exploratory data. Regression data should be boring and predictable. Exploratory data can be messy because its purpose is discovery. Mixing both styles creates failures that are difficult to classify and easy to ignore.

Assertions and Evidence

A useful assertion proves the outcome that matters. Depending on the topic, that may be visible text, a state transition, a disabled control, a created record, a rejected request, a deep link target, a dialog choice, or a security boundary. The assertion should be specific enough to catch bugs and stable enough to survive harmless UI changes.

Evidence should shorten triage. Capture screenshots, traces, logs, request ids, app versions, device names, browser versions, created record ids, and relevant response bodies where they help. Evidence collected without purpose becomes noise, but targeted evidence makes a failure actionable.

A strong review question is simple: if this test fails tomorrow, will the report tell us where to look? If the answer is no, improve names, setup, assertions, and attachments before adding more coverage.

Practice Scenarios

Use this scenario to practice cypress custom commands in a realistic way. Start with preconditions, then list the action, expected result, negative branch, and recovery branch. Add data values that make the scenario reproducible. Avoid vague instructions such as check screen or verify flow.

For api login for authenticated specs, ask what can go wrong for a real user and what failure would cost the team most. Then decide whether the case belongs in smoke, regression, exploratory testing, or a one time release checklist. This prevents overloading one suite with every possible concern.

Scenario 2: Stable selector helper for complex widgets

For stable selector helper for complex widgets, ask what can go wrong for a real user and what failure would cost the team most. Then decide whether the case belongs in smoke, regression, exploratory testing, or a one time release checklist. This prevents overloading one suite with every possible concern.

Scenario 3: Create order command that yields an id

For create order command that yields an id, ask what can go wrong for a real user and what failure would cost the team most. Then decide whether the case belongs in smoke, regression, exploratory testing, or a one time release checklist. This prevents overloading one suite with every possible concern.

Scenario 4: Shared address component filler

For shared address component filler, ask what can go wrong for a real user and what failure would cost the team most. Then decide whether the case belongs in smoke, regression, exploratory testing, or a one time release checklist. This prevents overloading one suite with every possible concern.

Scenario 5: Toast assertion around visible state

For toast assertion around visible state, ask what can go wrong for a real user and what failure would cost the team most. Then decide whether the case belongs in smoke, regression, exploratory testing, or a one time release checklist. This prevents overloading one suite with every possible concern.

Common Mistakes

Mistake 1: Hiding the assertion that matters

Hiding the assertion that matters usually appears when a team optimizes for speed before clarity. The test may pass locally, but the design does not explain the product claim, the state dependency, or the reason for the chosen technique.

The fix is to make the decision visible. Rename the helper, narrow the selection, isolate the data, add a meaningful wait, move the assertion closer to the behavior, or split one oversized case into focused checks. Small clarity improvements compound across the full suite.

Mistake 2: Putting arbitrary waits inside commands

Putting arbitrary waits inside commands usually appears when a team optimizes for speed before clarity. The test may pass locally, but the design does not explain the product claim, the state dependency, or the reason for the chosen technique.

Mistake 3: Making one command per click

Making one command per click usually appears when a team optimizes for speed before clarity. The test may pass locally, but the design does not explain the product claim, the state dependency, or the reason for the chosen technique.

Mistake 4: Forgetting TypeScript Chainable declarations

Forgetting TypeScript Chainable declarations usually appears when a team optimizes for speed before clarity. The test may pass locally, but the design does not explain the product claim, the state dependency, or the reason for the chosen technique.

Mistake 5: Creating shared data without cleanup

Creating shared data without cleanup usually appears when a team optimizes for speed before clarity. The test may pass locally, but the design does not explain the product claim, the state dependency, or the reason for the chosen technique.

Review Checklist

The test has one clear behavior under review.
The title explains the user or system outcome.
Preconditions include role, data, environment, and state.
The chosen technique is stable enough for regression.
The test avoids fixed waits unless time itself is the rule.
Assertions prove outcomes, not just clicks or navigation.
Negative and recovery paths are considered for high risk flows.
Cleanup is owned and visible.
Failure evidence would help another person debug.
The case belongs to the right smoke, regression, or release suite.
The case links to a requirement, defect, risk, or checklist item.
The case can be updated when behavior changes.

Use this checklist during pull request review and after major failures. A green run can still hide weak coverage. A failed run can still be valuable if it points to a real product problem or a test design problem that the team can fix.

To deepen this topic, connect it with cypress best practices, cypress vs playwright 2026, build test automation framework. Internal links are not just SEO. They help a learner move from tool mechanics to test design, framework structure, and risk based thinking.

For hands on practice, open the QABattle arena, choose a challenge related to this topic, and write the test approach before touching the tool. After the run, compare your result with the checklist and note one improvement for the next attempt.

If you want a structured path across manual testing, automation, API testing, performance, and modern AI evaluation skills, create a free account at QABattle. Treat each battle as a small release decision: what risk matters, what evidence proves it, and what you would automate next.

Final Workflow

Use this final workflow when applying cypress custom commands on a real project.

Define the behavior and user risk.
Choose the right test level.
Prepare controlled data and environment state.
Use the most readable tool feature for the job.
Wait for meaningful product state.
Assert the outcome that matters.
Capture evidence that speeds up triage.
Clean up data or make shared state read only.
Review the case for clarity and maintenance.
Place the case in the correct suite.

The best testing work is specific and maintainable. It does not depend on lucky timing, hidden state, or a single expert who remembers why the suite works. It turns product risk into checks that other people can read, run, and improve.