VTEX Developer Portal

Linking an app

When linking an app, your computer's local files sync to our cloud development environment. This means that any change done locally in the code you are working on will be sent to the cloud and then reflected in the workspace in which you are working.

In practice, you will be able to actually verify your changes by accessing the account you are logged in using the workspace you are using to develop.

Linking an app is only possible in Development workspaces. When using a Production workspace, an app can only be tested if it is already published and installed.

Step by step

To link your app and start seeing your changes in real time, follow the instructions below:

  1. Make sure you already are logged into the desired account and using a Developer workspace;
  2. Using your terminal, access the app's directory in your local files;
  3. Once in the accurate directory, type the following command in the terminal:

vtex link

After that, IO performs a series of tasks on its own until the following message is displayed in the terminal, once everything is OK: App linked successfully

From then on, every change can be seen in your browser in real time. But remember: the changes remain in your local files and can only be seen using the workspace you are workingon.

If you are comfortable with your changes and want to make your changes publicly available , verify our documentation for it.

Linking an app is one of the steps to making your code's new version public, meaning that it will become available to your end users. For more details on the next steps and to better understand the full flow, access the recipe on Making your new app version publicly available.

Updated a day ago


Linking an app


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.