{
  "doc": {
    "id": "api/commands/clearlocalstorage",
    "title": "clearLocalStorage | Cypress Documentation",
    "description": "Clear data in localStorage for current domain and subdomain in Cypress.",
    "section": "api",
    "source_path": "/llm/markdown/api/commands/clearlocalstorage.md",
    "version": "24a73f8a97175663aaffd3b016289fb2a523a4ea",
    "updated_at": "2026-05-14T20:17:33.301Z",
    "headings": [
      {
        "id": "api/commands/clearlocalstorage#clearlocalstorage",
        "text": "clearLocalStorage",
        "level": 1
      },
      {
        "id": "api/commands/clearlocalstorage#syntax",
        "text": "Syntax",
        "level": 2
      },
      {
        "id": "api/commands/clearlocalstorage#usage",
        "text": "Usage",
        "level": 3
      },
      {
        "id": "api/commands/clearlocalstorage#arguments",
        "text": "Arguments",
        "level": 3
      },
      {
        "id": "api/commands/clearlocalstorage#yields-learn-about-subject-management",
        "text": "Yields Learn about subject management",
        "level": 3
      },
      {
        "id": "api/commands/clearlocalstorage#examples",
        "text": "Examples",
        "level": 2
      },
      {
        "id": "api/commands/clearlocalstorage#no-args",
        "text": "No Args",
        "level": 3
      },
      {
        "id": "api/commands/clearlocalstorage#clear-all-localstorage",
        "text": "Clear all localStorage",
        "level": 4
      },
      {
        "id": "api/commands/clearlocalstorage#specific-key",
        "text": "Specific Key",
        "level": 3
      },
      {
        "id": "api/commands/clearlocalstorage#clear-localstorage-with-the-key-appname",
        "text": "Clear localStorage with the key 'appName'",
        "level": 4
      },
      {
        "id": "api/commands/clearlocalstorage#clear-all-localstorage-matching-app-regexp",
        "text": "Clear all localStorage matching /app-/ RegExp",
        "level": 4
      },
      {
        "id": "api/commands/clearlocalstorage#rules",
        "text": "Rules",
        "level": 2
      },
      {
        "id": "api/commands/clearlocalstorage#requirements-learn-about-chaining-commands",
        "text": "Requirements Learn about chaining commands",
        "level": 3
      },
      {
        "id": "api/commands/clearlocalstorage#assertions-learn-about-assertions",
        "text": "Assertions Learn about assertions",
        "level": 3
      },
      {
        "id": "api/commands/clearlocalstorage#timeouts-learn-about-timeouts",
        "text": "Timeouts Learn about timeouts",
        "level": 3
      },
      {
        "id": "api/commands/clearlocalstorage#command-log",
        "text": "Command Log",
        "level": 2
      },
      {
        "id": "api/commands/clearlocalstorage#see-also",
        "text": "See also",
        "level": 2
      }
    ]
  },
  "chunks": [
    {
      "id": "api/commands/clearlocalstorage#syntax",
      "doc_id": "api/commands/clearlocalstorage",
      "heading": "Syntax",
      "heading_level": 2,
      "content_markdown": "## Syntax\n\n```\ncy.clearLocalStorage()cy.clearLocalStorage(key)cy.clearLocalStorage(options)cy.clearLocalStorage(keys, options)\n```\n\n### Usage\n\n**Correct Usage**\n\n```\ncy.clearLocalStorage() // clear all local storage\n```\n\n### Arguments\n\n**keys _(String, RegExp)_**\n\nSpecify key to be cleared in localStorage.\n\n**options _(Object)_**\n\nPass in an options object to change the default behavior of `cy.clearLocalStorage()`.\n\n| Option | Default | Description |\n| --- | --- | --- |\n| `log` | `true` | Displays the command in the [Command log](/llm/markdown/app/core-concepts/open-mode.md#Command-Log) |\n\n### Yields [Learn about subject management](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Subject-Management)\n\n*   `cy.clearLocalStorage()` yields the localStorage for the current domain.\n",
      "section": "api",
      "anchors": [
        "syntax"
      ],
      "path": "/llm/json/chunked/api/commands/clearlocalstorage.json",
      "token_estimate": 115
    },
    {
      "id": "api/commands/clearlocalstorage#arguments",
      "doc_id": "api/commands/clearlocalstorage",
      "heading": "Arguments",
      "heading_level": 3,
      "content_markdown": "### Arguments\n\n**keys _(String, RegExp)_**\n\nSpecify key to be cleared in localStorage.\n\n**options _(Object)_**\n\nPass in an options object to change the default behavior of `cy.clearLocalStorage()`.\n\n| Option | Default | Description |\n| --- | --- | --- |\n| `log` | `true` | Displays the command in the [Command log](/llm/markdown/app/core-concepts/open-mode.md#Command-Log) |\n",
      "section": "api",
      "anchors": [
        "arguments"
      ],
      "path": "/llm/json/chunked/api/commands/clearlocalstorage.json",
      "token_estimate": 71
    },
    {
      "id": "api/commands/clearlocalstorage#examples",
      "doc_id": "api/commands/clearlocalstorage",
      "heading": "Examples",
      "heading_level": 2,
      "content_markdown": "## Examples\n\n### No Args\n\n#### Clear all localStorage\n\n```\ncy.clearLocalStorage()\n```\n\n### Specific Key\n\n#### Clear localStorage with the key 'appName'\n\n```\ncy.clearLocalStorage('appName')\n```\n\n#### Clear all localStorage matching `/app-/` RegExp\n\n```\ncy.clearLocalStorage(/app-/)\n```\n",
      "section": "api",
      "anchors": [
        "examples"
      ],
      "path": "/llm/json/chunked/api/commands/clearlocalstorage.json",
      "token_estimate": 47
    },
    {
      "id": "api/commands/clearlocalstorage#rules",
      "doc_id": "api/commands/clearlocalstorage",
      "heading": "Rules",
      "heading_level": 2,
      "content_markdown": "## Rules\n\n### Requirements [Learn about chaining commands](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Chains-of-Commands)\n\n*   `cy.clearLocalStorage()` requires being chained off of `cy`.\n\n### Assertions [Learn about assertions](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Assertions)\n\n*   `cy.clearLocalStorage()` will only run assertions you have chained once, and will not [retry](/llm/markdown/app/core-concepts/retry-ability.md).\n\n### Timeouts [Learn about timeouts](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Timeouts)\n\n*   `cy.clearLocalStorage()` cannot time out.\n",
      "section": "api",
      "anchors": [
        "rules"
      ],
      "path": "/llm/json/chunked/api/commands/clearlocalstorage.json",
      "token_estimate": 60
    },
    {
      "id": "api/commands/clearlocalstorage#command-log",
      "doc_id": "api/commands/clearlocalstorage",
      "heading": "Command Log",
      "heading_level": 2,
      "content_markdown": "## Command Log\n\n**_Clear all localStorage_**\n\n```\ncy.clearLocalStorage(/prop1|2/).then((ls) => {  expect(ls.getItem('prop1')).to.be.null  expect(ls.getItem('prop2')).to.be.null  expect(ls.getItem('prop3')).to.eq('magenta')})\n```\n\nThe commands above will display in the Command Log as:\n\nWhen clicking on `clearLocalStorage` within the command log, the console outputs the following:\n",
      "section": "api",
      "anchors": [
        "command-log"
      ],
      "path": "/llm/json/chunked/api/commands/clearlocalstorage.json",
      "token_estimate": 49
    }
  ]
}