{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"upgrade-your-product-version","__idx":0},"children":["Upgrade your product version"]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Community","Pro","Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you are working in Reunite, your project updates automatically when new versions are released and you trigger a new build."," ","If you are working locally, you must update your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," file to the version you want your project to use."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Keep Realm up to date to prevent exposing your systems to security risks."," ","To learn about Redocly's release schedule for patching known security vulnerabilities, see ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/faq/security-fixes"},"children":["Security vulnerability fixes"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-begin","__idx":1},"children":["Before you begin"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make sure you have the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["for local development: ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://nodejs.org/en"},"children":["NodeJS LTS"]},", v22.12.0 or later (alternatively -- v20.19.5 or later)"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Product package names"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This content applies to the following Redocly products and their corresponding package names:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reef = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@redocly/reef"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Revel = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@redocly/revel"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Redoc = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@redocly/redoc"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Redoc + Reef = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@redocly/redoc-reef"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Redoc + Revel = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@redocly/redoc-revel"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Revel + Reef = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@redocly/revel-reef"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace package names in sample commands and JSON dependencies with the Redocly product you are using."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"check-product-version","__idx":2},"children":["Check product version"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you can decide if you want to update your version, you need to know what version your project is currently using."," ","You can ascertain the version your project is using with the developer tools in your browser."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To verify the version your project is using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["From the Reunite editor, open the preview or production build of your project in your browser."," ","Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["View"]}," drop-down in the top left corner of the page."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/view-project-dropdown-3a7a318773a14e03.png","alt":"Screenshot of top right corner of Reunite editor with View drop-down","framed":true,"withLightbox":true},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Right-click anywhere on a page and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Inspect"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Inspect Element"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the developer tools pane, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Console"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You should see the version displayed as in the following screenshot:"]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/console-version-b0211e87901ea218.png","alt":"Screenshot of the console in Chrome showing the Redocly Realm version","framed":true,"withLightbox":true},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After you have determined what version your project is running, you can find the latest version to help you decide if you want to upgrade."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"find-the-latest-product-version","__idx":3},"children":["Find the latest product version"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You might know what version you are running, but not whether it is the latest version."," ","You can see a list of all available versions or get only the latest one."," ","Use the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/changelog"},"children":["changelog"]}," or npm commands."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To find the latest Realm version, use the following npm command:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm view @redocly/realm version"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To find a list of all available Realm versions, use the following npm command:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm view @redocly/realm versions"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Other products"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you are using a different product than Realm, such as Reef, Revel, Redoc, or a combination, substitute that product name in the command."," ","For example, to find the latest Reef version, use the following command: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm view @redocly/reef"]},"."," ","See a list of product names and their corresponding packages in the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#before-you-begin"},"children":["Before you begin"]}," section."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"run-a-specific-product-version","__idx":4},"children":["Run a specific product version"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You may need to run a specific version, instead of the latest version."," ","You can control what version your project runs, using a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," file."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"run-a-specific-product-version-locally","__idx":5},"children":["Run a specific product version locally"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you want to run a specific version, you need to add a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," file to your project if you don't already have one."," ","You also need to install ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@redocly/cli"]}," globally and your Redocly product to your project directory."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To run a specific version working locally:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the following ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," file to the root of your project."," ","Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["realm"]}," with the Redocly product you are using and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*"]}," for the version you want to run:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"package.json","header":{"title":"package.json","controls":{"copy":{}}},"source":"{\n   \"name\": \"demo\",\n   \"version\": \"1.0.0\",\n   \"description\": \"\",\n   \"author\": \"\",\n   \"license\": \"UNLICENSED\",\n   \"dependencies\": {\n   \"@redocly/realm\": \"*\"\n }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Install your product to your project directory using the following command:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm i"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Install ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@redocly/cli"]}," globally using the following command:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm i @redocly/cli -g"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Run your project using the following command:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly preview"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using your developer tools, verify the version in the console as described in ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#check-product-version"},"children":["Check product version"]},"."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"run-a-specific-product-version-in-reunite","__idx":6},"children":["Run a specific product version in Reunite"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you are working in the Reunite editor, your project by default uses the most recent version."," ","It automatically updates whenever new versions are released and you trigger a new build."," ","However, you might want to use a specific version and not update automatically."," ","In that case, add a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," file to your project with the version listed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To run a specific version in Reunite:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a new development branch."]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Create a branch steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you make any changes to your project, create a new branch."," ","This new branch is a place where you can make changes without affecting the published site until you are ready."," ","Iterate on your changes based on reviews by your team."," ","After the updates have been approved, you can merge your changes into the published site."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create a new branch:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["From the Reunite editor, click the name of the current branch at the top of the page."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/current-branch-1a305df1983bdb3f.png","alt":"Screenshot where current branch is on project page","framed":true,"withLightbox":true},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enter the name for your new branch, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["new-dev-branch"]},", and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create branch"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reunite automatically replaces spaces with hyphens ",{"$$mdtype":"Tag","name":"kbd","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-"]}]},"because spaces are not allowed in branch names."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On the new development branch, add a new file named ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," by clicking the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["+"]}," icon and selecting ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New file"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Paste the following configuration into the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," file."," ","Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["realm"]}," with the Redocly product you are using and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*"]}," for the version you want to run:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"package.json","header":{"title":"package.json","controls":{"copy":{}}},"source":"{\n   \"name\": \"demo\",\n   \"version\": \"1.0.0\",\n   \"description\": \"\",\n   \"author\": \"\",\n   \"license\": \"UNLICENSED\",\n   \"dependencies\": {\n   \"@redocly/realm\": \"*\"\n }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Commit your update."]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Create update steps"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Commit"]}," button, or the commit icon."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/commit-icon-0331679fa4116dbc.png","alt":"Screenshot with commit icon","framed":true,"withLightbox":true},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Review the diff by clicking on the modified file."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/modified-file-6df7aba6538ca739.png","alt":"Screenshot with list of modified files under commit button","framed":true,"withLightbox":true},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you are finished reviewing the diff, you can close the tab on the (changes) file."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["(Optional) you can deselect the files you want to exclude from the commit."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enter a commit message describing your updates."," ","For example, \"Update index.md\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Commit"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After the preview build has completed, open it using the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["View"]}," drop-down in the top right corner of the page."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/view-project-dropdown-3a7a318773a14e03.png","alt":"Screenshot of top right corner of Reunite editor with View drop-down","framed":true,"withLightbox":true},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#check-product-version"},"children":["Check the version"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To run this version in your production build, ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/reunite/project/pull-request/open-pull-request"},"children":["open a pull request"]},", then review and ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/reunite/project/pull-request/review-pull-request#merge-a-pull-request"},"children":["merge it"]}," with the new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["package.json"]}," file."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":7},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/get-started"},"children":["Get started with Realm"]}]}," - Take your first steps building your project"]}]}]},"frontmatter":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Community","Pro","Enterprise","Enterprise+"],"keywords":{"includes":["package.json"]}},"tagList":["admonition","configOptionRequirements","html","img","partial"],"title":"Upgrade your product version","lastModified":"2026-09-24T16:15:48.000Z"}