{
  "doc": {
    "id": "cloud/get-started/setup",
    "title": "Setup",
    "description": "Learn how to set up your project to record tests in Cypress Cloud.",
    "section": "cloud",
    "source_path": "/llm/markdown/cloud/get-started/setup.md",
    "version": "524ff5211e60b5d53e55d6ad976d83966f66e7cd",
    "updated_at": "2026-04-30T14:20:05.396Z",
    "headings": [
      {
        "id": "cloud/get-started/setup#set-up-your-project-to-record-in-cypress-cloud",
        "text": "Set up your project to record in Cypress Cloud",
        "level": 1
      },
      {
        "id": "cloud/get-started/setup#setup",
        "text": "Setup",
        "level": 2
      },
      {
        "id": "cloud/get-started/setup#set-up-a-project-to-record",
        "text": "Set up a project to record",
        "level": 3
      },
      {
        "id": "cloud/get-started/setup#view-your-recorded-run",
        "text": "View your recorded run",
        "level": 3
      }
    ]
  },
  "content": {
    "type": "root",
    "children": [
      {
        "type": "heading",
        "depth": 1,
        "children": [
          {
            "type": "text",
            "value": "Set up your project to record in Cypress Cloud"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "To get started with Cypress Cloud, "
          },
          {
            "type": "link",
            "title": null,
            "url": "https://cloud.cypress.io/signup",
            "children": [
              {
                "type": "text",
                "value": "sign up"
              }
            ]
          },
          {
            "type": "text",
            "value": " to start your 30 day free trial - including all premium Cypress Cloud features and plenty of test results to let you experience the power of Cypress Cloud!"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Once complete, come back here for information on how to integrate your app with Cypress Cloud."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "Setup"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "When you configure the open source Cypress app to record tests to Cypress Cloud, you'll see data from your project's latest recorded runs."
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "You typically want to record when running tests in "
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/app/continuous-integration/overview.md",
            "children": [
              {
                "type": "text",
                "value": "Continuous Integration"
              }
            ]
          },
          {
            "type": "text",
            "value": ", but you can also record your tests when running locally."
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Make sure to "
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/app/get-started/install-cypress.md",
            "children": [
              {
                "type": "text",
                "value": "install"
              }
            ]
          },
          {
            "type": "text",
            "value": " and "
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/app/get-started/open-the-app.md",
            "children": [
              {
                "type": "text",
                "value": "open"
              }
            ]
          },
          {
            "type": "text",
            "value": " the Cypress app to get started recording!"
          }
        ]
      },
      {
        "type": "heading",
        "depth": 3,
        "children": [
          {
            "type": "text",
            "value": "Set up a project to record"
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 1,
        "spread": true,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Click on the Runs tab of your project within "
                  },
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/app/core-concepts/open-mode.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Cypress"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": "."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Click Connect to Cypress Cloud."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "You will need to log in to record your tests, so you'll be prompted to log in to Cypress Cloud here if you haven't already done so."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Choose who owns the project. You can personally own it or select an organization you're a member of. If you don't have any organizations, click Manage organizations. Organizations work just like they do in GitHub and enable you to separate your personal and work projects. "
                  },
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/cloud/account-management/organizations.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Read more about organizations"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": "."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": true,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "If you don't have any existing projects, you'll have the opportunity to create a new one here. If you have existing projects and want to create a new one, you can click Create new to make a new one."
                  }
                ]
              },
              {
                "type": "list",
                "ordered": false,
                "start": null,
                "spread": false,
                "children": [
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Fill in the name of your project (this is only for display purposes and can be changed later)."
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Choose whether this project is Public or Private. See more about "
                          },
                          {
                            "type": "link",
                            "title": null,
                            "url": "/llm/markdown/cloud/account-management/projects.md#Public-vs-Private",
                            "children": [
                              {
                                "type": "text",
                                "value": "Public-vs-Private project settings"
                              }
                            ]
                          },
                          {
                            "type": "text",
                            "value": "."
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Alternatively, if you've already created a project in Cypress Cloud, you can link your project by selecting it from the dropdown. Make sure to select a clean project that has not previously been linked to an existing project."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Click Setup Project."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Now you should see a view explaining how to record your first run with your record key."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "After setting up your project, Cypress inserts a unique "
                  },
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/cloud/account-management/projects.md#Project-ID",
                    "children": [
                      {
                        "type": "text",
                        "value": "projectId"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": " into your Cypress configuration file. If you're using source control, we recommend that you check your configuration file, including the `projectId`, into source control."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": true,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Within "
                  },
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/app/continuous-integration/overview.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Continuous Integration"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": " or from your local computer's terminal, pass the displayed "
                  },
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/cloud/account-management/projects.md#Record-key",
                    "children": [
                      {
                        "type": "text",
                        "value": "Record Key"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": " while running the "
                  },
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/app/references/command-line.md#cypress-run",
                    "children": [
                      {
                        "type": "text",
                        "value": "cypress run"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": " command."
                  }
                ]
              },
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Provide record key directly:"
                  }
                ]
              },
              {
                "type": "code",
                "lang": null,
                "meta": null,
                "value": "cypress run --record --key <record key>"
              },
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Or set record key as environment variable:"
                  }
                ]
              },
              {
                "type": "code",
                "lang": null,
                "meta": null,
                "value": "export CYPRESS_RECORD_KEY=<record key>"
              },
              {
                "type": "code",
                "lang": null,
                "meta": null,
                "value": "cypress run --record"
              }
            ]
          }
        ]
      },
      {
        "type": "heading",
        "depth": 3,
        "children": [
          {
            "type": "text",
            "value": "View your recorded run"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "🎉 Your tests are now recording! As soon as tests finish running, you will see them in "
          },
          {
            "type": "link",
            "title": null,
            "url": "https://on.cypress.io/cloud",
            "children": [
              {
                "type": "text",
                "value": "Cypress Cloud"
              }
            ]
          },
          {
            "type": "text",
            "value": " and in the Runs tab of "
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/app/core-concepts/open-mode.md",
            "children": [
              {
                "type": "text",
                "value": "Cypress"
              }
            ]
          },
          {
            "type": "text",
            "value": "."
          }
        ]
      }
    ]
  },
  "token_estimate": 632
}