VTEX Developer Portal

Creating a Development workspace

Workspaces in development mode can link, publish and install apps. These workspaces enjoy greater development freedom, since they do not handle traffic from any user except yourself.

Because development workspace do not have any level of user traffic, you should use them whenever you want to perform changes in your code. But notice: they cannot be promoted to Master nor used for A/B testing - only Production workspaces can.

Step by step

  1. Log into the desired VTEX account;
  2. Run the following command:
vtex use {workspaceName}

️ Remember to replace the value in the curly brackets according to your store's scenario and needs.

Once you are sure of the changes performed in the Development workspace, it is time to create a Production workspace in order to test your changes with some user traffic.

But be aware: the Production workspace will not inherit the changes performed in the Development workspace. All changes performed in the Development workspace will need to be replicated in the new Production workspace.

Once created, the Developer workspace has no expiration date, which means that settings will remain stored in it unless there is any conflict with the configurations of the store’s Master workspace.

In these cases, the Master settings will always prevail over the settings of the other account's workspaces, including the Developer one in which you are working, since the account's workspaces work as a copy of the version available to the end user.

️ Stick to the list of workspaces created for your account. It is important to keep a short list, not only for your own organization but also to spare platform infrastructure resources. Currently, there is no service responsible for automatically deleting unused workspaces from an account. This means that you must manually delete workspaces that are no longer being used by running vtex workspace delete {workspaceName}.

️ Creating a Development workspace 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 3 days ago

Creating a Development workspace

Suggested Edits are limited on API Reference Pages

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