VTEX Toolbelt

The CLI that offers all you need to start using the VTEX IO platform efficiently.

Summary

• How do we empower you?
• First step: Installing the VTEX Toolbelt
• Developing an app locally
• Customize your prompt
• FAQ
• Contributing
• Send us feedback

How do we empower you?

VTEX Toolbelt is a command-line program that gives you access to all of the features in the VTEX platform and increases your productivity, allowing you to:

• Manage your apps quickly: List, install and uninstall available apps in your account;
• Work safely on your personal environments: List, create and remove workspaces;
• Easily ship changes to your final user: Promote a workspace to master, making it public in your account URL;
• See what you are creating in real time: Develop new apps in link mode, using automatic synchronization;
• Go live from the command line: Publish apps to the VTEX App Store.

Getting started: Installing the VTEX Toolbelt

To use the VTEX Toolbelt, you'll need to install other engines that will also be useful when developing for VTEX.

Node.js to run the tool

• Install Node.js here: Toolbelt is written in Typescript and designed to run on Node.js. (Node is the runtime that executes the JS and allows our tool to run and work at your computer)
• Install yarn here: yarn is a way to manage your code, organize content in packages that you can download, share and... install, just like our CLI :)

Now do you have Node.js and Yarn? Let's install the Toolbelt.

Installing the Toolbelt with yarn

yarn powers app development to React, Node and VTEX IO! Install the Toolbelt using yarn and start working with us generating automatically all the files you'll need to create apps in the future. To install it, run:

 yarn global add vtex

  npm install -g vtex

Using the CLI

After installation, run vtex to see our commands and what each one of them does.

  $ vtex
    Welcome to VTEX I/O
    Login with vtex login <account>

    Usage: vtex <command> [options]

    Commands:

      add <app>               Add app(s) to the manifest dependencies
      deprecate [app]         Deprecate app(s)
      init                    Create basic files and folders for your VTEX app
      install [app]           Install an app (defaults to the app in the current directory)
      link                    Start a development session for this app
      setup                   Setup your development environment (configure tsconfig and tslint, run yarn)
      list                    List your installed VTEX apps
      logs                    Show apps production logs
      login                   Log into a VTEX account
      logout                  Logout of the current VTEX account
      promote                 Promote this workspace to master
      publish [path]          Publish the current app or a path containing an app
      switch <account>        Switch to another VTEX account
      test                    Run your VTEX app unit tests
      uninstall [app]         Uninstall an app (defaults to the app in the current directory)
      unlink [app]            Unlink an app on the current directory or a specified one
      update                  Update all installed apps to the latest version
      use <name>              Use a workspace to perform operations
      whoami                  See your credentials current status

      browse [endpoint]       Browse an endpoint of the store under development

      config get <name>                 Gets the current value for the requested configuration
      config set <name> <value>         Sets the current value for the given configuration

      deps list                              List your workspace dependencies
      deps update [app]                      Update all workspace dependencies or a specific app@version
      deps diff [workspace1] [workspace2]    Show dependencies difference between two workspaces

      infra install <name>     Install a service
      infra list [name]        List installed services
      infra update             Update all installed services

      local manifest    Generate manifest from package.json
      local package     Generate package.json from manifest
      local account     Show current account and copy it to clipboard
      local workspace   Show current workspace and copy it to clipboard
      local token       Show user's auth token and copy it to clipboard

      port react       Convert your app from React 0.x to React 2.x

      release [releaseType/Version] [tagName]          Bump app version, commit and push to remote (git only)

      settings <app> [fields]                     Get app settings
      settings set <app> <fields> <value>         Set a value
      settings unset <app> <fields>               Unset a value

      redirects import <csvPath>      Import redirects for the current account and workspace
      redirects export <csvPath>      Export all redirects in the current account and workspace
      redirects delete <csvPath>      Delete redirects in the current account and workspace

      url                               Prints base URL for current account, workspace and account

      workspace                         Alias for vtex workspace info
      workspace create <name>           Create a new workspace with this name
      workspace delete <name>           Delete a single or various workspaces
      workspace info                    Display information about the current workspace
      workspace list                    List workspaces on this account
      workspace promote                 Promote this workspace to master
      workspace reset [name]            Delete and create a workspace
      workspace use <name>              Use a workspace to perform operations

    Options:

      -h, --help  show help information

Second step: log into your VTEX account

Start by using vtex login to receive your credentials and be able to access other features. Simply type this command and follow the instructions.

😉 Note that link and publish implicitly checks if you're logged, and if you're not, it asks your credentials before proceeding.

To develop locally: use vtex link

When you log in to an account, you can create your own workspaces to work on your ideas or see what is in production. To do so:

1. On an app directory, run vtex link and click on or copy the provided URL into your browser;
2. Now on, VTEX Toolbelt will monitor your files for change and sync them with what you see automatically.

Wanna know something cool? You can customize your prompt

You can configure your terminal prompt to display relevant information about your current context, like which account you're logged into and which workspace you are currently using.

Just like knowing which git branch you're currently in, having this info in your prompt will help you avoid mistakes and be faster when using VTEX IO.

How to do so?

bash users

If you are a bash user you can start customizing your command prompt by running the following command:

echo "source $(npm root -g)/vtex/plugins/bash/vtex.bash" >> ~/.bashrc
echo "source $(npm root -g)/vtex/plugins/bash/prompt.bash" >> ~/.bashrc

😉 For fine grained control, use only the first script and add __vtex_ps1 manually to your prompt.

fish users

If you want a pretty, ready-made Git + VTEX prompt you can copy plugins/fish/fish_prompt.fish to the ~/.config/fish/functions folder. To see the changes, simply restart your shell by typing fish.

cp (npm root -g)/vtex/plugins/fish/fish_prompt.fish ~/.config/fish/functions/
fish

💡 If you installed Toolbelt using yarn, you should replace (npm root -g) with (yarn global dir).

Frequently Asked Questions

Contributing

Follow the steps on contributing.md.

License

MIT

Tell us what you think about Toolbelt

📡 We are always looking for ways to improve your experience. Please, send us feedback about the VTEX Toolbelt here.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[4.2.1]

Fixed

• The URL is now shown as a log when opening browser windows.

[4.2.0]

Updated

• Extend VBase client, integrating the getConflicts and the resolveConflict endpoints.

[4.1.0] - 2024-08-01

Changed

• Pack toolbelt using nodejs 20
• Allow specific builder config to override the common config for pinned dependencies

[4.0.5] - 2024-03-25

Fixed

• handle OPTIONS request for CORS
• update publish-stable-aws pipeline

[4.0.4] - 2023-11-03

Fixed

• CI publishing pipeline

[4.0.0] - 2023-10-30

Removed

• Websocket-based debugger tunnel;

Changed

• Update recommendedEdition in edition.ts toedition-store@5.x`

[3.0.0] - 2021-10-20

• Release major 3.x as stable.

[3.8.1-beta] - 2021-10-07

Changed

• Undo a remotion of a condition in ManifestUtil for OCLIF_COMPILATION

[3.8.0-beta] - 2021-06-09

Removed

• App purchases and all code related to it

[3.7.3-beta] - 2021-05-31

Changed

• Update @vtex/cli-plugin-plugins to ^1.13.2

[3.7.2-beta] - 2021-05-10

Changed

• Use templates as remote configs instead of hardcoded strings.

[3.7.1-beta] - 2021-05-07

Fixed

• Fix typo in version update message

[3.7.0-beta] - 2021-05-03

Changed

• Update @vtex/cli-plugin-plugins

[3.6.1-beta] - 2021-04-22

• Fix set edition command to handle prompt cancellations
• Add check on set edition command to install tenant-provisioner app in sponsor account

[3.6.0-beta] - 2021-04-13

Added

• [vtex init] Service worker example to list of templates

[3.5.2-beta] - 2021-04-09

Fixed

• [install] Treat InstallStatus as a variable not as a type

Changed

• [autoupdate] Update to version 0.0.2

[3.5.1-beta] - 2021-04-01

Fixed

• [hook] Change imports from node_modules to package name

[3.5.0-beta] - 2021-04-01

Changed

-[Autoupdate] Add as default command

[3.4.0-beta] - 2021-03-30

Changed

-[Messages] Update Plugins / Default commands message UX

[3.3.4-beta] - 2021-03-29

Fixed

• Use space instead of : in help commands

[3.3.3-beta] - 2021-03-23

Fixed

• [vtex lib] Fix import x from 'vtex' error by forcing symlink

[3.3.2-beta] - 2021-03-23

[3.3.1-beta] - 2021-03-22

Added

• Terms and conditions message when linking or publishing a react app.
• composable-commerce-sq4 as codeowners

Changed

• Changed logging protocol from http to https.

• Add self package to react packages as devDependency

[3.3.0-beta] - 2021-03-10

Fixed

• [plugins] Disallow installations of non-working plugins

Added

• [plugins] Feature flag for PLUGINS_ALLOW_LIST

[3.2.1-beta] - 2021-03-09

Fixed

• [help] Display topic only if it contains command

[3.2.0-beta] - 2021-03-09

Added

• It is now possible to specify a project folder name when using the init command.

Fixed

• Searchs for the default_branch name for a GitHub Repo before trying to download it. We used to assume the default was always master but GitHub is adoping main.

[3.1.4-beta] - 2021-02-12

• stale issues github workflow.

[3.1.4-beta] - 2021-02-12

[3.1.3-beta] - 2021-02-12

Changed

• Don't throw error when switching to same account

Fixed

• [setup] including types of peerDependencies

[3.1.2-beta] - 2021-02-04

Changed

• Don't throw error when switching to same account

[3.1.1-beta] - 2021-02-04

Changed

• [Github Action] Detach create release and integrate slack notification inside npm workflow

[3.1.1-beta] - 2021-02-04

Changed

• [Github Action] Detach create release and integrate slack notification inside npm workflow

[3.1.0-beta] - 2021-01-29

Changed

• [Help] vtex --help new commands format (Groups)

[3.0.0-beta] - 2021-01-19

Added

• [Major] New major 3.x

[2.121.2] - 2021-01-13

Fixed

-[release] Fix nothing to commit algorithm in order to release app.

[2.121.1] - 2021-01-05

Added

-[autoupdate] skip checkForDeprecation and checkForOutdate for autoupdate command.

[2.121.0] - 2021-01-04

Added

• [Toolbelt Notification] Integrate toolbelt with toolbelt-notification

[2.120.0] - 2020-12-07

Added

• [Update / Deprecate message] Custom message based on user OS.

[2.119.4] - 2020-12-03

Fixed

• [authUrl] Returning function that was exported to vtex url

[2.119.3] - 2020-12-03

Changed

• [vtex url] Refactor to use as oclif plugin.

[2.119.2] - 2020-11-18

Added

• Upgrade @vtex/cli-plugin-submit to 0.2.0
  • Adjustments to First Party App teams usage

[2.119.1] - 2020-11-13

Fixed

• [npm] Fix inconsistent deploy

[2.119.0] - 2020-11-13

Changed

• [Feature Flags]
  • Cache locally all flags
  • New class to use feature flags

[2.118.2] - 2020-11-11

Fixed

• Upgrade @vtex/cli-plugin-workspace to 0.1.2
  • Fix vtex workspace promote

[2.118.1] - 2020-11-10

Fixed

• [ToolbeltConfig] Force client to requireAuth: false

[2.118.0] - 2020-11-10

Changed

• [vtex deploy] Update plugin version
• [@vtex/api] Update package version

[2.117.2] - 2020-11-09

Changed

• [vtex login] Change package responsable to open the browser

[2.117.1] - 2020-11-06

Changed

• [vtex setup] Update tooling dependency versions.

[2.117.0] - 2020-11-04

Changed

• [vtex whoami] Refactor to use as oclif plugin.

[2.116.0] - 2020-11-04

Changed

• [Toolbelt Config Server] Enable use of feature flag inside vtex.toolbelt-config-server

[2.115.5] - 2020-11-03

Changed

• Add retries to builder hub app link client

[2.115.4] - 2020-11-03

Fixed

• [relink] Force app to link from scratch when StickyHost change on relink

[2.115.3] - 2020-10-16

Fixed

• [update] updateNotify access propety of undefined object.

[2.115.2] - 2020-10-15

Fixed

• [updateNotify] Display new version update based on vtex channel (e.g., stable and beta).

[2.115.1] - 2020-10-07

Changed

• [vtex submit] Update command plugin version
  • Fix relative imports
  • Update vtex

[2.115.0] - 2020-10-07

Added

• [vtex workspace] Update command plugin version
  • Add --conflict flag to workspace promote command.

[2.114.2] - 2020-10-06

Changed

• [vtex submit] Update command plugin version
  • Handle App Store validation errors

[2.114.1] - 2020-10-06

Added

• Support to new billingOptions types

[2.114.0] - 2020-10-06

Changed

• [vtex deploy] Refactor to use as oclif plugin.

[2.113.0] - 2020-10-06

Changed

• [vtex infra] Refactor to use as oclif plugin.

[2.112.0] - 2020-10-05

Added

• [installer] New deploy method by using oclif-dev pack and oclif-dev publish.

Changed

• [tsconfig] Changed build folder name from build to lib.

[2.111.0] - 2020-09-08

Added

• [vtex submit] Add plugin package.

[2.110.1] - 2020-08-24

Changed

• [vtex redirects] Update plugin version:
  • Add missing progress dependency.

[2.110.0] - 2020-08-19

Changed

• [vtex deps] Refactor to use as oclif plugin.

[2.109.0] - 2020-08-18

Changed

• [vtex workspace] Refactor to use as oclif plugin.

[2.108.1] - 2020-08-12

Changed

• [vtex login] Use new VTEX ID login flow:
  • Fix free TCP port retrieval: use detect-port package instead of get-port.
  • Fix issue on WSL2 by specifying host binding to 127.0.0.1 when starting the server.

[2.108.0] - 2020-08-11

Added

• [vtex workspace promote] Conflict handling.

Changed

• [vtex workspace promote] Log messages.
• [vtex redirects] Refactor to use as oclif plugin.

[2.107.0] - 2020-08-06

Changed

• [vtex workspace abtest] Update command plugin version
• Remove CommandError class and move to FLOW_ISSUE_ERROR kind inside ErrorReport class.

Fixed

• [vtex login] Revert to use old login flow due to issues on local server port.

[2.106.4] - 2020-07-30

Changed

• [vtex login] Use new VTEX ID login flow.

[2.106.3] - 2020-07-28

Changed

• Remove function calls on the root of the module on the commands: vtex release, vtex test unit, vtex setup, vtex publish, vtex link and vtex deploy
• [ManifestUtil] Remove duplicated manifest functions

[2.106.2] - 2020-07-24

Changed

• [vtex abtest] Refactor to use as oclif plugin.

[2.106.1] - 2020-07-22

Changed

• [vtex workspace abtest] Revert vtex abtest to subcommand of workspace command

[2.106.0] - 2020-07-22

Changed

• [vtex abtest] Rename command from vtex workspace abtest to vtex abtest
• [vtex abtest] Refactor to use as oclif plugin.
• [dependencies] Remove unused dependencies

Fixed

• [vtex browse] Fix workspace not being added to url.
• [vtex login] Revert to use old login flow due to issues on Safari browsers.

[2.105.1] - 2020-07-16

Fixed

• [oclif:entrypoint] Only run oclif command when the entrypoint is the main script.
• [vtex settings set] Cast value before setting field.
• [vtex logout] Local token is now invalidated before deleting local data. Also a URL is opened on the browser to invalidate the auth cookie stored.

Changed

• [vtex edition] Refactor command to use as oclif plugin.
• [vtex login] Use new VTEX ID login flow.

Removed

• [vtex browse] Remove support authority logic, as VTEX ID token doesn't expose user roles.

[2.105.0] - 2020-07-09

Changed

• [vtex test / vtex lighthouse] Refactored this commands to use them as oclif plugins.

[2.104.0] - 2020-07-06

Changed

• [vtex test e2e] Simplified test summary linking to full report.

[2.103.0] - 2020-06-29

Added

• [vtex link] Parameters to enable login singleline.

[2.102.1] - 2020-06-16

Changed

• [docs] Update session about development.
• [vtex link/relink] Add telemetry on builder-hub host changes.

[2.102.0] - 2020-06-08

Fixed

• [vtex test e2e] Handle error when executed on an unlinked app.

Added

• [All Commands] new flag --trace that sets the jaeger-debug-id header automatically on all requests.
• [vtex link] Added cypress.json to the list of watched files.

[2.101.1] - 2020-05-28

Added

• [vtex test e2e] Added retry count to account for cold tester-hub start.
• [vtex link] Generate linkID and set the x-vtex-bh-link-id header on link and relink requests to builder-hub.

Changed

• [vtex publish/link] Ignore Cypress generated videos/screenshots.
• [ErrorReport] Do not send wrong usage errors to telemetry.

Fixed

• [vtex login, vtex switch] Prompt workspace creation if it doesn't exist.

[2.101.0] - 2020-05-19

Added

• [vtex publish] Message referencing location of the published docs if any.
• [vtex logs] Add logs command.

Changed

• [vtex promote] Remove report to evolution manager.

[2.100.1] - 2020-05-12

Changed

• [ErrorReport] Use @vtex/node-error-report.
• [vtex promote] Change log level on evolution manager report error from error to debug.

[2.100.0] - 2020-05-11

Added

• [vtex config] Config reset command.
• [welcome, login, switch] Add welcome command.

Changed

• Refactor clients organization and instantiation.
• [edition-check] Change error log from warn to debug level.
• [vtex login] Get release notes message from vtex.toolbelt-config-server.

Fixed

• [clients:billing] Use new URL format.
• [vtex test e2e] Show screenshot and videos assets URLs received from vtex.tester-hub new API.
• [vtex undeprecate] 403 error when account switch is necessary.

Updated

• [oclif] oclif-plugin-spaced-commands to fix alias documentation.

[2.99.3] - 2020-05-05

Fixed

• [telemetry] Sanitize jwt tokens and simplify buffers serializtion.
• [dependencies] Add graphql - @vtex/api's peer dependency.
• Session management.

[2.99.2] - 2020-04-30

Fixed

• [vtex link] no-watch flag behaviour.
• [vtex workspace delete] force flag type.

Added

• [CLIPreTasks] Outdated version checking.

[2.99.1] - 2020-04-29

Fixed

• Treat errors when checking edition of account on a workspace command.

[2.99.0] - 2020-04-29

Fixed

• [redirects] Encode delimiter before exporing .csv file to avoid conflicts.
• [vtex install, vtex uninstall] Behaviour when action is cancelled by the user.

Added

• [hooks:init] Allow to customize help.
• [child-processes] DEBUG_CP environment variable for debugging child processes.
• Command vtex lighthouse for vtex internal Google's Lighthouse tool
• [vtex promote] Save workspace promotion info in evolution manager.

Changed

• Update release notes message.
• Improve SSE errors logs.
• [vtex setup] Add GraphQL files to lint-staged config.
• [vtex workspace] Auto-switch to edition-store when creating new workspace.
• [dependencies] Update yarn from ~1.21.0 to ^1.22.4.

[2.98.0] - 2020-04-22

Added

• [telemetry:reporter] Create and send reporter meta metrics.

Changed

• Migrate to framework oclif.
• [vtex install] Improve error logging.
• [telemetry:reporter] Refactor reporting.

Fixed

• [telemetry:ErrorReport] Increase ErrorReport serialization depth.
• [telemetry:reporter] File locking error.
• [vtex setup] Not running when flag --all is omitted.

[2.97.0] - 2020-04-09

Changed

• [local-data] Use new paths on ~/.vtex for persisting data. (older session path at ~/.config/configstore/vtex.json will still be updated).

[2.96.1] - 2020-04-07

Fixed

• [vtex rewriter] Use rewriter new redirects API with single binding support.

Changed

• [debugger:node, debugger:dotnet] Use wss protocol instead of ws and new app.io.vtex.com URL format.
• [clients:sponsor, vtex support] Use HTTPS and new URL app.io.vtex.com format.
• [telemetry:collector] Flush just before exiting process.
• [sse] Check if token is valid before creating connection.
• [sse] Abort process on 401 or 403 server errors.
• [sse:telemetry] Register sse errors with errorKind SSEError.
• Update release notes message.

[2.96.0] - 2020-04-06

Added

• [vtex test e2e] Show test's logs.
• [vtex setup] Create new flags for specifying what to setup:
  • --all: Select all setup flags existent.
  • --typings: Download and setup GraphQL and React typings.
  • --tooling: Setup Prettier, Husky and ESLint.
  • --tsconfig: Setup React's and Node's TSconfig, if applicable.

Changed

• [telemetry] Add suffix specifying if env.platform is container or WSL.

[2.95.0] - 2020-04-01

Added

• Command vtex test e2e for end-to-end testing.

[2.94.0] - 2020-03-31

Added

• [vtex init] Show checkout-ui-settings template for users outside VTEX.

Fixed

• [dependencies] Downgrade to use opn@~5.2.0 instead of open.

[2.93.1] - 2020-03-30

[2.93.0] - 2020-03-30

Added

• [vtex debug dotnet] Support for debugging .Net Core apps.
• Init time metric in telemetry.

Fixed

• [vtex setup] Make generated yarn format command also format .jsx and .tsx files.
• [dependencies:open] Fix open usage that caused malfunction on wsl.

Changed

• [vtex redirects] Downloads the bindings along with the redirects.

[2.92.4] - 2020-03-27

Fixed

• Update open to version 7.0.3.

[2.92.3] - 2020-03-25

Fixed

• [vtex redirects] Logs exact uri that has a problem.

[2.92.2] - 2020-03-23

Fixed

• Use new list api for exporting redirects.
• Deprecation checking.
• PayloadTooLarge error in telemetry.

[2.92.1] - 2020-03-17

Changed

• Update release notes URL.

Added

• Improvements in telemetry.
  • Add an interval to remote flush telemetry.
  • Use a file to write telemetry object argument for TelemetryReporter.
  • Send TelemetryReporter meta errors to toolbelt-telemetry.

Fixed

• ErrorReport class throwing UnhandledException.

[2.92.0] - 2020-03-09

Added

• Add "edition app" to vtex init.
• Allow testing editions in non-master workspaces.

[2.91.1] - 2020-03-03

Changed

• [vtex init] Use better template for store.

[2.91.0] - 2020-03-03

Fixed

• Release notes URL.

Changed

• [vtex init] Keep only store template for non VTEX users and change template repository.
• [vtex init] Allow to select template organization.

[2.90.0] - 2020-03-02

Added

• [vtex init] Include payment-provider-example.
• Automatically report errors.

Changed

• [vtex setup] Update eslint-config packages version.
• Update typescript to 3.8.2
• Update eslint and eslint-config-vtex.
• Fixed eslint errors.

Fixed

• Make deprecation checking non-blocking.

[2.89.0] - 2020-02-19

Added

• [vtex init] checkout-ui-settings template.

Fixed

• Fix Unhandled Exception when publish fails.

Removed

• Spinner on vtex publish.

Refactored

• Remove ramda usage on vtex publish command.

[2.88.2] - 2020-02-14

Fixed

• Typo in release notes announcement.

[2.88.1] - 2020-02-12

Added

• Release notes announcement.

Removed

• Remove vtex validate and vtex production deprecated commands.

[2.88.0] - 2020-02-11

Changed

• Sort package.json dependencies when adding with vtex setup.
• Use open package instead of opn.
• Update @vtex/api from v3.67.1 to v3.71.1

Refactored

• Create AuthProviders classes to concentrate authentication logic.
• Create SessionManager class to manager session specific data.
• [vtex login, vtex logout, vtex switch] Use SessionManager class.

[2.87.4] - 2020-02-06

Changed

• [vtex publish] Only allow the workspace flag when logged in the vendor account.

[2.87.3] - 2020-02-05

Changed

• Update clear-module dependency to major 4.

Fixed

• [vtex setup] Increased TSConfig and Typings getting timeout.
• [vtex settings unset] Fix argument parsing.

Removed

• Remove bluebird package:
  • [vtex settings, vtex infra, vtex redirects] Remove bluebird utilities from all subcommands.
  • Remove bluebird from cli entrypoint.
  • Remove bluebird from build listener.

[2.87.2] - 2020-02-05

Changed

• Use prompts package for confirmation prompts.
• Answering confirmation prompts now only need the confirmation character (or just enter). No need to type the character and enter.
• [vtex deploy] Improved error messages.

Removed

• [vtex publish] Removed new deployment process announcement.

[2.87.1] - 2020-02-03

Fixed

• Add deprecation precheck.

Changed

• Use esModuleInterop compiler option.

[2.87.0] - 2020-01-30

Added

• [vtex setup] lint-staged and husky configurations.

Changed

• [vtex setup] tooling step with updated dependencies.

Fixed

• Invalid URLs when cluster variable is set.
• [vtex link] Fix bad_toolbelt_version error message.

[2.86.1] - 2020-01-24

Fixed

• [vtex link] Fix relink not properly updating active link

Changed

• [vtex setup] Change types urls hosts from vtex.vteximg.com.br to $appVendor.vtexassets.com

[2.86.0] - 2020-01-23

Added

• yes flag to vtex publish

Refactor

• Yarn linked modules files sending.

Fixed

• Fix vtex infra install creating semver object

[2.85.0] - 2020-01-16

Added

• Create an OS notification when an link dies (except for windows systems).

Fixed

• Short circuit bad toolbelt version error when linking.

Changed

• Add dependencies pinned by builder-hub scoped by builder.

[2.84.1] - 2020-01-13

Fixed

• Debug logs on linked apps now are printed on verbose mode.
• Post publish message now notifies about vtex deploy instead of vtex validate.

[2.84.0] - 2020-01-13

Added

• Display account name when confirming actions on master workspace.
• vtex deploy command.

Deprecated

• Deprecate vtex validate command in favor of vtex deploy.

Refactored

• Refactor vtex add.
• Refactor vtex unlink.
• Use ManifestEditor class on vtex link.

[2.83.2] - 2020-01-07

Fixed

• Spawn of git add on paths with special chars.

[2.83.1] - 2020-01-07

Changed

• Debug response headers on unhandled errors when available
• Log request url and method on unhandled errors when request.status is available and is 4xx or 5xx

[2.83.0] - 2020-01-07

Fixed

• Typo on message requesting to change account when validating

Added

• Log url for auth-sse
• VTEX_CLUSTER env variable now specifies which cluster will be used
• vtex config set cluster and vtex config get cluster are now available and specify the cluster to be used

[2.82.1] - 2020-01-02

Fixed

• Use url shortener for new publish process docs url

Added

• Message after vtex publish regarding new vtex validate command

[2.82.0] - 2019-12-30

Added

• Add update method to builder hub's error requesting to update toolbelt
• Add confirm prompt on vtex publish
• Add URL to changelog on update notification

Refactor

• Refactor vtex install and vtex uninstall

[2.81.4] - 2019-12-23

Added

• Add message regarding publish process changes when trying to publish

[2.81.3] - 2019-12-23

Refactor

• Refactor vtex deprecate, vtex undeprecate, vtex publish

[2.81.2] - 2019-12-19

Added

• Use v8-compile-cache to slightly reduce commands startup

[2.81.1] - 2019-12-18

Changed

• Update vtex setup added lint deps

[2.81.0] - 2019-12-17

Added

• Show upload progress
• Show project original and compressed sizes
• Add a 90MB limit to project original size

Removed

• Remove unnused client

[2.80.1] - 2019-12-16

Fixed

• The command vtex redirects export no longer exports duplicate entries.

[2.80.0] - 2019-12-16

Added

• Periodically prompt user for feedback about toolbelt's usage experience.

[2.79.4] - 2019-12-11

Changed

• Update typescript to ^3.7.3
• Update formatter and linter dependencies

[2.79.3] - 2019-12-11

[2.79.2] - 2019-12-10

Removed

• Removed outdated scripts

[2.79.1] - 2019-12-10

Changed

• Lock dependencies versions up to minor changes

[2.79.0] - 2019-12-06

Added

• New command to validate a published app

Fixed

• Use vtex/api on undeprecate request instead of axios

[2.78.6] - 2019-12-04

Refactor

• Make vtex init never change the cloned app's manifest.

[2.78.5] - 2019-12-04

Refactor

• Delete legacy publish and link files

[2.78.4] - 2019-12-03

[2.78.3] - 2019-12-02

Added

• Use onUnsubscribe event feature to notify users about links closing connection.

[2.78.2] - 2019-11-27

Fixed

• Use `vendor.appname@major.xonABTesterandRewriterclients constructors in order to use newnode-vtex-api` routing.

[2.78.1] - 2019-11-21

Fixed

• Update version of node-vtex-api to do requests with https

[2.78.0] - 2019-11-19

Changed

• Store tokens of other accounts visited in order to change account without opening browser when possible

[2.77.15] - 2019-11-07

Fixed

• Ignore errors warming up the route map after create a workspace

[2.77.14] - 2019-11-06

Fixed

• Fix copy to clipboard of vtex local token when it's executed on Mac OS.

[2.77.13] - 2019-10-28

Fixed

• Error Unhandled exception when generating local token/workspace/account, due to nonexistent display.

[2.77.12] - 2019-10-25

Changed

• Use tenant-provisioner's migrate API to set account's editions.

Fixed

• Remove CHANGELOG.md from list of ignored files

[2.77.10] - 2019-10-21

Fixed

• Fix vtex setup overriding the app's existing package.json.

[2.77.9] - 2019-10-18

Added

• Add .git/** to defaultIgnored files

[2.77.8] - 2019-10-18

Removed

• inquirer package

[2.77.7] - 2019-10-16

Fixed

• vtex redirects import --reset when the redirects index is empty in vtex.rewriter.

[2.77.6] - 2019-10-15

Changed

• Update vtex setup ESLint configuration to match current recipe instructions.

[2.77.5] - 2019-10-11

[2.77.4] - 2019-10-10

Fixed

• vtex init for react-guide

[2.77.3] - 2019-10-09

Fix

• Typescript compile error that happened on darwin platform

[2.77.2] - 2019-10-09

Changed

• Update typescript version to 3.6.3

[2.77.1] - 2019-10-02

Changed

• Increase timeout and retries in the rewriter client.
• Sort the redirects list by the from prop before starting import.

[2.77.0] - 2019-10-02

[2.76.3] - 2019-10-02

Added

• Ensure node >= v10
• Add debug logs on node version, OS basic info and command executed

[2.76.2] - 2019-10-01

Changed

• Use new rewriter API for redirects management.

[2.76.1] - 2019-09-23

Fixed

• Add vtex test to README.

[2.76.0] - 2019-09-20

Changed

• Update versions of eslint related packages added by vtex setup

[2.75.0] - 2019-09-20

Added

• Support for running tests on VTEX IO apps.

[2.74.2] - 2019-09-18

Fix

• Error logging using winston

[2.74.1] - 2019-09-18

Changed

• Enforce node version >= 10

[2.74.0] - 2019-09-18

[2.73.1] - 2019-09-11

Fixed

• Correctly print error objects when the --verbose flag is set.

[2.73.0] - 2019-09-10

[2.72.0] - 2019-09-10

[2.71.0] - 2019-09-05

Changed

• Make update notifier yarn aware.

[2.70.0] - 2019-09-05

• Parameter -f or --force in vtex publish to skip check for sem ver.

[2.69.1] - 2019-09-04

Fixed

• Add vtex redirects import/export/delete to README.

Refactor

• Use prettier as formatter and eslint as linter

[2.69.0] - 2019-09-03

Added

• vtex redirects import/export/delete command for handling redirects in vtex.rewriter.

[2.68.2] - 2019-09-03

Refactor

• vtex setup command

[2.68.1] - 2019-08-29

• Fix test

[2.68.0] - 2019-08-28

• Add revenue and last 24h revenue to AB test status.

[2.67.2] - 2019-08-28

• Upgrade @vtex/api to ^3.46.0

[2.67.1] - 2019-08-23

• Upgrade chokidar to major 3

[2.67.0] - 2019-08-21

Added

• Parameter -f or --force in vtex install to skip check for route conflicts.

[2.66.4] - 2019-08-19

Fixed

• Do not throw error when log is an empty string.

[2.66.3] - 2019-08-19

Changed

• Stop ignoring eslint configuration files.

[2.66.2] - 2019-08-15

[2.66.1] - 2019-08-15

• Use jest as testing framework

[2.66.0] - 2019-08-07

Changed

• Filter out artificial JSON logs that are meant to be logged to splunk, except in verbose mode

[2.65.6] - 2019-08-07

Changed

• Add a header to send debug requests to the runtime instead of the app.

[2.65.5] - 2019-08-06

Changed

• Do not show masterdata-graphql-guide in vtex init for users outside VTEX.

[2.65.4] - 2019-08-06

Added

• vtex init does not show unnecessary templates for users outside VTEX.

[2.65.3] - 2019-07-25

Fixed

• vtex update correctly shows available updates for runtimes.

[2.65.2] - 2019-07-19

Fixed

• Add ignore-engines flag when running yarn.

[2.65.1] - 2019-07-18

Changed

• Stop saving sticky-host locally until issue with Builder-hub's fork-ts-checker-webpack-plugin issue is resolved.

[2.65.0] - 2019-06-28

Added

• Support - to switch back to previous account or workspace.

[2.64.3] - 2019-06-26

Fixed

• On vtex update, correctly show when there are no updates available.

[2.64.2] - 2019-06-25

Fixed

• A/B testing status tables.

[2.64.1] - 2019-06-25

Added

• Account name is displayed when changing workspaces.

[2.64.0] - 2019-06-24

Changed

• vtex update calls the housekeeper API to check available updates.

[2.63.9] - 2019-06-18

Added

• Display account name on workspace reset prompt
• Remove environment on greetings prompt

[2.63.8] - 2019-06-17

Changed

• Removes deprecated staging environment support

[2.63.7] - 2019-06-14

[2.63.6] - 2019-06-05

Changed

• Use yellow instead of red for vtex update table headers color

[2.63.5] - 2019-06-04

Fixed

• Use app's root as cwd when running scripts during vtex release.

[2.63.4] - 2019-06-04

Changed

• Bump axios version.

[2.63.3] - 2019-05-31

Fixed

• Fix vtex init.

[2.63.2] - 2019-05-30

Added

• Add graphql example.

[2.63.1] - 2019-05-30

Added

• Add admin example.

[2.63.0] - 2019-05-29

Added

• vtex ls now shows apps inherited by the account's edition.

[2.62.0] - 2019-05-28

Added

• vtex edition and vtex edition set commands to manipulate account's editions.

[2.61.1] - 2019-05-27

Fixed

• Check if the returned data is really from the vtex.admin-login app when testing if it is installed in the current account/workspace.

[2.61.0] - 2019-05-27

Added

• Add support command, which allows logging into another account that has your support app installed.

Changed

• Added funcionality to browse command to allow logging into an admin with a support token.

[2.60.2] - 2019-05-28

Fixed

• Use double quotes around the resolved yarn path so vtex link works correctly on Windows platforms.

[2.60.0] - 2019-05-25

Added

• Add --qr flag to the browse command, that outputs a QR code; intended for mobile devices.

[2.59.0] - 2019-05-24

[2.58.0] - 2019-05-24

Changed

• Use new login route whenever it is available in the current workspace.

[2.58.0] - 2019-05-21

Added

• vtex url command to print the base URL for the current account, workspace and environment.

[2.57.1] - 2019-05-21

Changed

• Stop making vtex update attempt to update app major.

[2.57.0] - 2019-05-21

Changed

• Add JSON schema to Manifest.

[2.56.7] - 2019-05-15

Changed

• Enable saving StickyHost locally.

[2.56.6] - 2019-05-13

[2.56.5] - 2019-05-13

Added

• Always run yarn locally as an initial step of vtex link and vtex publish for ./node and ./react folders.

[2.56.4] - 2019-05-10

Fixed

• Correctly resolve app root for the vtex release command.

[2.56.3] - 2019-05-10

Fixed

• Improved Node debugger stability.

[2.56.2] - 2019-05-08

Changed

• Running vtex setup on every vtex link is temporarily disabled until vtex setup becomes less intrusive.

Fixed

• Minor fix to eslint configuration in vtex setup.

[2.56.1] - 2019-05-08

Changed

• Temporarily disable saving StickyHost locally until routing behavior is fixed.

[2.56.0] - 2019-05-08

Changed

• Move typings fetching to the vtex setup command.
• Make vtex setup download tslint configuration (react and node).
• Make vtex setup merge tsconfig entries from builder-hub.
• vtex link runs vtex setup by default, except when run with option no-setup.

[2.55.7] - 2019-05-08

Fixed

• Wrap apps client promises in Bluebird, so we can use .tap.

[2.55.6] - 2019-05-08

Fixed

• Check and inform if ab-tester status route returns null results.

[2.55.5] - 2019-05-02

Added

• Generic vtex browse command for browsing the store.

[2.55.4] - 2019-05-02

Fixed

• Correctly parse and print error message in vtex deps update and vtex unlink commands.

[2.55.3] - 2019-05-02

Fixed

• vtex whoami shows that the user is not logged in if it fails to read the workspace state.

[2.55.2] - 2019-05-02

Fixed

• Do not allow users to create workspace names with hyphens.

[2.55.1] - 2019-04-30

[2.55.0] - 2019-04-25

Fixed

• A/B test finish messages (again).

[2.54.7] - 2019-04-24

Changed

• Check if vtex.ab-tester is installed before attempting to use A/B testing functionality.

[2.54.6] - 2019-04-18

Changed

• Upgrade to @vtex/api to version 3.4.0 or higher.

[2.54.5] - 2019-04-18

Changed

• Watcher debouncer wait time from 300ms to 1000ms.

[2.54.4] - 2019-04-17

Changed

• Completely remove the vtex production command.

[2.54.3] - 2019-04-17

Fixed

• A/B Test finish message.

[2.54.2] - 2019-04-16

Fixed

• Fix Changelog and add .git/ to .npmignore.

[2.54.1] - 2019-04-16

Fixed

• Builder availability requests being cached by updating to @vtex/api^3.3.1.

[2.54.0] - 2019-04-15

Added

• Implement workspace A/B testing interface.

[2.53.11] - 2019-04-10

Fixed

• Undesired logs appearing during vtex publish.

[2.53.10] - 2019-04-08

Added

• delivery-theme repo to the vtex init command.

[2.53.9] - 2019-04-04

Added

• service-example repo to the vtex init command.

[2.53.8] - 2019-04-02

Fixed

• Start debugger tunnel only for node apps.

[2.53.7] - 2019-04-01

Added

• The vtex release command accept a valid (semver) version as its first argument.

[2.53.6] - 2019-03-28

Added

• --unsafe (-u) option for the vtex link command, which enables apps being linked with typescript errors.

[2.53.5] - 2019-03-28

Changed

• Replace enquirer with prompt-confirm for confirmation prompts.

[2.53.4] - 2019-03-28

Fixed

• Request vtex.builder-hub's availability for route map warm-up instead of querying Colossus, which not every user is allowed to do.

Added

• Retries for vtex.builder-hub availability requests and debugger connection.

[2.53.3] - 2019-03-28

Added

• Workspace information (whether it is in dev or production mode) in the output of the vtex whoami command.

[2.53.2] - 2019-03-27

Fixed

• Stop trying to get manifest of apps with specific majors or minors from VTEX Registry, which is forbidden.

[2.53.1] - 2019-03-27

Fixed

• Fix relink behaviour for linked node dependencies.

[2.53.0] - 2019-03-25

Changed

• Replaced the inquirer dependency with enquirer.

[2.52.2] - 2019-03-21

Fixed

• Added missing dependency js-yaml.

[2.52.1] - 2019-03-21

Fixed

• Conflicts with the master.

[2.52.0] - 2019-03-21

Added

• Allows usage of VTEX IO clusters other than production and staging, by setting the environment variable VTEXIO_REGION.

[2.51.4] - 2019-03-21

Changed

• Remove filtering of unhandled errors before printing to console (when using --verbose).

[2.51.3] - 2019-03-21

Fixed

• App versions colored diff was not showing prerelease tags.

[2.51.2] - 2019-03-19

Added

• Add render-guide and masterdata-graphql-guide to the vtex init command options.

[2.51.1] - 2019-03-19

Added

• Makes possible to switch directly to another account/workspace with the vtex switch {account}/{workspace} syntax.

[2.51.0] - 2019-03-19

Changed

• Remove eslint setup copying when linking.
• Remove eslint-related dependencies from the project.

[2.49.1] - 2019-03-18

Fixed

• Forward production value to reset command when coming from use command.

[2.49.0] - 2019-03-18

Changed

• Workspace lifecycle now conforms to Chronos with a workspace being created as dev or production.
• Command vtex production is deprecated and it is not possible to change the production flag of a workspace after it is created.
• Links are only allowed in dev workspaces.
• Only production workspaces may be promoted to master.

[2.48.1] - 2019-03-14

Fixed

• Answer for switching to previous account after vtex publish is now correctly considered.

[2.48.0] - 2019-03-14

Changed

• Upgrade @vtex/api to version 2.3.0.

[2.47.0] - 2019-03-14

Fixed

• Config is saved before changing account for app publishing and is automatically restored when going back to previous account.

[2.46.0] - 2019-03-14

[2.45.0] - 2019-03-14

Added

• Option --major (-m) in vtex update for updating app majors.

[2.44.0] - 2019-03-14

[2.43.0] - 2019-03-12

Added

• Warm up workspace route map on creation.

[2.42.4] - 2019-03-11

Added

• vtex release pre alias for vtex release prerelease.

[2.42.3] - 2019-03-09

Added

• Error messages for missing install licenses and unsupported regions.

[2.42.2] - 2019-03-07

[2.42.1] - 2019-02-28

[2.42.0] - 2019-02-28

Added

• Close Chrome tab after successful login on Mac.

[2.41.8] - 2019-02-28

Fixed

• File watcher during vtex link should not queue files as 'deleted' when they are simply updated

[2.41.7] - 2019-02-27

Fixed

• vtex release only updates CHANGELOG.md on stable releases.

[2.41.6] - 2019-02-27

Fixed

• Post release scripts run with vtex release have output correctly piped to stdio.

[2.41.5] - 2019-02-27

Changed

• Make short the default and only option for vtex ls.
• Adjust colors of vendor name on vtex ls.
• Use clean tables on update, infra list, and workspace list commands.

[2.41.4] - 2019-02-26

Added

• Add confirmation of account/workspace before uninstalling apps.

[2.41.3] - 2019-02-25

Changed

• Use new auth-server routes.

[2.41.2] - 2019-02-25

Added

• --no-watch option for vtex link.

[2.41.0] - 2018-02-21

Added

• vtex release command analogous to releasy.

[2.38.0] - 2018-02-12

Added

• Enable running commands inside subdirectories.

[2.35.0] - 2018-01-17

Added

• Add --short option to list.

[0.19.0] - 2016-05-19

Changed

• Change stable endpoints to new apps and workspaces model.
• shelljs to v0.7.0.
• update-notifier to v0.7.0.

Fixed

• webpack-dev-server redirect without port.

[0.18.0] - 2016-04-19

Added

• Add ora spinner.

Fixed

• Dev workflow.
• vtexsay message.

[0.17.1] - 2016-04-18

Fixed

• update-notifier missing dependency.

[0.17.0] - 2016-04-18

Added

• Add update-notifier.

Changed

• eslint-plugin-react to v5.0.1.
• Add the sandbox name on webpack's publicPath.

[0.16.0] - 2016-04-14

Changed

• From meta.json to manifest.json.
• .vtexrc is now a JSON file.
• eslint-config-vtex to v3.0.1.
• archiver to v1.0.0.
• babel-eslint to v6.0.2.

Fixed

• babel-eslint dependency version.

[0.15.1] - 2016-03-01

Fixed

• Fix unbalanced parentheses

[0.15.0] - 2016-03-01

Changed

• .vtexrc instead of using GalleryEndpoint now uses AppsEndpoint and WorkspacesEndpoint.
• shelljs -> 0.6.0.
• glob -> 7.0.0.
• node-libs-browser -> 1.0.0.
• prompt -> 1.0.0.
• eslint -> 2.0.0.
• babel-eslint -> 5.0.0.
• eslint-plugin-react -> 4.1.0.

Fixed

• Fix chalk usage
• Use stable gallery endpoints

[0.14.1] - 2016-01-01

Changed

• Update some deps and fix login error with start token.

[0.14.0] - 2015-12-21

Changed

• node_modules, package.json and .git are ignored by default.

[0.13.2] - 2015-12-14

Fixed

• Fix undeclared rl var on windows.

[0.13.1] - 2015-12-09

Changed

• We dumped CoffeeScript in favor of ES6! Since all the code was deleted and written in ES6, you may encounter some issues, if you do, please open an issue.
• Improve error handling.
• Show publish error details.

Fixed

• Fix grammar in some messages.
• #73

[0.13.0] - 2015-11-19

Changed

It updates the JSON we send to the gallery! Just that :)

• #82

[0.12.0] - 2015-11-06

Added

• Add special auth method for `@vtex.comor@vtex.com.br` e-mails.

[0.11.0] - 2015-11-05

Changed

• On this update we changed the way we tell Storefront that you're watching a new app!
• Instead of WebSockets, we now use HTTP for keep alive, not as elegant but made a few bugs disappear.

Added

• We also added a message on vtex login to make the prompts less ambiguous. Still on the login, there's now a validation on the account prompt! It should be alphanumeric with only dashes - as a special character.
• #73
• #72

[0.10.4] - 2015-10-30

Fixed

Fix location of warnings in sandbox changes.

[0.10.3] - 2015-10-29

Fixed

Fix disconnection issue when exiting by Ctrl + C and workspace creation request.

• #69

[0.10.2] - 2015-10-28

Fixed

• Fix login message when using Ctrl + C to exit the prompt and moar error messages.

[0.10.1] - 2015-10-28

Fixed

• Fix signalr-client dependency.

[0.10.0] - 2015-10-27

Hello, fellow developers!

I'm glad to announce that THE COOKIE IS DEAD!!11!!

Ok... maybe not that much. Let me explain:

The cookies for the sandbox and workspace pretty much still exists, BUT, we've created a good and ol' barrel of abstraction on top of it so you don't have to worry anymore.

Now we have a convention for setting those cookies. We will create a workspace with the name sb_<your-vtex-developer-email> and on that workspace you'll have a sandbox with the name <your-vtex-developer-email>. Because of that, you don't need to type the sandbox as an argument of watch anymore!

You will access those by simply putting a querystring on the link you use for development, for example: `storename.beta.myvtex.com/?workspace=sb_mydeveloperemail@whut.com`.

All we ask in return is that when you log in you inform us the account you wish to be logged (yeah, only one account at a time).

I know you're excited, yeah, gimme a hug homie <3

TL;DR: You don't need to type the sandbox name on watch or set the cookies anymore.

#

First big important note: If you have any credentials cached, please logout and login again.

Second big important note: Delete the previous vtex_workspace and vtex_sandbox cookies that you have setted before.

#

• #58
• #48 (closed due to deprecation)

[0.9.4] - 2015-10-22

Added

• Update changes log to include warnings from server response.
• #60

[0.9.3] - 2015-10-06

Added

• Now, server sets an environment variable called HOT (dayum yeah).
• #55

[0.9.2] - 2015-09-28

Hello again, fellas.

Today we have a round of the good ol' fixes.

Users of the npm@3 version will be glad to know that the dependencies issues were handled. tiny-lr got updated and everything is now beautifully working. Also, removed grunt-coffeelint for having peer dependencies issues too.

I hope that people get a little less confused when running the toolbelt when he doesn't need to send anything to the sandbox servers. Why? Well, we got a new message just for that case :)

And, for the finale, the toolbelt will warn you properly when the port of the server is occupied. I think that shows good manners, exploding the way it used before doesn't show you have good loving parents!

• #43
• #49
• #51
• #53

[0.9.1] - 2015-09-26

Nothing big here, just fixes some issue with the watch command when running with no flags.

• #50

[0.9.0] - 2015-09-24

Let's kick the dust off and start with the good stuff!

The file vtex-webpack is now gone (we won't miss you, so k bye). Now we have a new one, shiny and pretty called webpack (yep), it lives on the lib folder.

The logic behind the -w and -s options is now there, and the entrypoint for them is now on vtex-watch, which makes much more sense since they are options of watch.

Last but not least, the VTEX Toolbelt server now uses the new react-transform!

Instead of using webpack-dev-server, we're using an express server with webpack-hot-middleware and webpack-dev-middleware. Note that webpack-dev-middleware doesn't write anything on disk and handles everything in memory, so don't freak out if you see your assets folder sitting there all alone.

This assumes some pre-configuration on the project to work properly (see Hot Module Replacement section on README). Besides, it's a world of new possibilities and probably makes it easier to make the dreamy multiple app hot reload that we all want!

On this release two main issues are fulfilled (actually, one is partially done):

• #44 (this is the partially one)
• #35