diff --git a/guides/studio-development.md b/guides/studio-development.md index 7dcf0ac3d7..f13bf10318 100644 --- a/guides/studio-development.md +++ b/guides/studio-development.md @@ -9,3 +9,17 @@ In production, the code used to facilitate Studio functionality will be retrieve - Clone the `cypress` repo - Run `yarn` - Run `yarn cypress:open` + +## Types + +The studio bundle provides the types for the `app` and `server` interfaces that are used within the Cypress code. To incorporate the types into the code base, run: + +```sh +yarn gulp downloadStudioTypes +``` + +or to reference a local `cypress_services` repo: + +```sh +CYPRESS_LOCAL_STUDIO_PATH= yarn gulp downloadStudioTypes +``` diff --git a/packages/app/src/studio/StudioPanel.vue b/packages/app/src/studio/StudioPanel.vue index 0b6ee1d24f..537ad3c493 100644 --- a/packages/app/src/studio/StudioPanel.vue +++ b/packages/app/src/studio/StudioPanel.vue @@ -12,10 +12,13 @@