vtex/oclif.manifest.json

The platform for e-commerce apps

{"version":"4.2.2","commands":{"browse":{"id":"browse","description":"Opens the URL relative to your current \u001b[38;5;149mworkspace\u001b[39m and \u001b[38;5;149maccount\u001b[39m in a new browser window.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex browse\u001b[39m","\u001b[38;5;205mvtex browse\u001b[39m admin"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false},"qr":{"name":"qr","type":"boolean","char":"q","description":"Prints a QR Code on the terminal.","allowNo":false}},"args":[{"name":"path","description":"Relative path from \u001b[38;5;149mhttps://{workspace}--{account}.myvtex.com/.\u001b[39m","default":""}]},"deprecate":{"id":"deprecate","description":"Deprecates the specified app, uninstalling and downgrading it to the latest stable version in every \u001b[38;5;149mVTEX account.\u001b[39m","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex deprecate\u001b[39m","\u001b[38;5;205mvtex deprecate\u001b[39m vtex.service-example@0.0.1"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false},"yes":{"name":"yes","type":"boolean","char":"y","description":"Answers yes to all prompts.","allowNo":false}},"args":[{"name":"appId","description":"Name and version of the app \u001b[38;5;149m({vendor}.{appname}@{x.x.x})\u001b[39m to deprecate.","required":false},{"name":"ithAppId","description":"Names and versions of multiple apps \u001b[38;5;149m({vendor}.{appname}@{x.x.x})\u001b[39m to deprecate.","required":false}]},"init":{"id":"init","description":"Copies starting files and folders from \u001b[38;5;149mVTEX\u001b[39m boilerplates into your local directories.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex init\u001b[39m","\u001b[38;5;205mvtex init project-name\u001b[39m"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false}},"args":[{"name":"projectName","required":false}]},"install":{"id":"install","description":"Installs an app on the current \u001b[38;5;149mworkspace\u001b[39m. If not specified which one, it defaults to the app in the current directory.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex install\u001b[39m","\u001b[38;5;205mvtex install\u001b[39m vtex.service-example@0.x","\u001b[38;5;205mvtex install\u001b[39m vtex.service-example@0.0.1"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false},"force":{"name":"force","type":"boolean","char":"f","description":"Installs the specified app without checking for route conflicts.","allowNo":false}},"args":[{"name":"appId","description":"Name and version of the app \u001b[38;5;149m({vendor}.{appname}@{x.x.x})\u001b[39m to install.","required":false},{"name":"ithAppId","description":"Names and versions of the multiple apps \u001b[38;5;149m({vendor}.{appname}@{x.x.x})\u001b[39m to install.","required":false}]},"link":{"id":"link","description":"Syncs the app in the current directory with the \u001b[38;5;149mdevelopment workspace\u001b[39m in use.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex link\u001b[39m -a youraccount -w yourworkspace"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false},"account":{"name":"account","type":"option","char":"a","description":"Starts a development session in the specified \u001b[38;5;149maccount\u001b[39m. Must be paired with the \u001b[38;5;205m--workspace\u001b[39m flag.","required":false},"clean":{"name":"clean","type":"boolean","char":"c","description":"Cleans builder cache","allowNo":false},"setup":{"name":"setup","type":"boolean","char":"s","description":"Locally sets typings before linking [see \u001b[38;5;205mvtex setup --help\u001b[39m]","allowNo":false},"no-watch":{"name":"no-watch","type":"boolean","description":"Doesn't watch for file changes after the initial link.","allowNo":false},"unsafe":{"name":"unsafe","type":"boolean","char":"u","description":"Allows linking the app despite Typescript errors.","allowNo":false},"workspace":{"name":"workspace","type":"option","char":"w","description":"Starts a development session in the specified \u001b[38;5;149mworkspace\u001b[39m. Can be paired with the \u001b[38;5;205m--account\u001b[39m flag to switch from the current \u001b[38;5;149maccount\u001b[39m and \u001b[38;5;149mworkspace\u001b[39m.","required":false}},"args":[]},"list":{"id":"list","description":"Lists the apps installed on the current \u001b[38;5;149mworkspace\u001b[39m and \u001b[38;5;149maccount\u001b[39m.","pluginName":"vtex","pluginType":"core","aliases":["ls"],"examples":["\u001b[38;5;205mvtex list\u001b[39m","\u001b[38;5;205mvtex ls\u001b[39m"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false}},"args":[]},"login":{"id":"login","description":"Logs in to a \u001b[38;5;149mVTEX account\u001b[39m.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex login\u001b[39m","\u001b[38;5;205mvtex login\u001b[39m storecomponents"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false},"workspace":{"name":"workspace","type":"option","char":"w","description":"Logs in the specified \u001b[38;5;149mworkspace\u001b[39m."}},"args":[{"name":"account","description":"\u001b[38;5;149mAccount\u001b[39m name to log in.","required":false}]},"logout":{"id":"logout","description":"Logs out of the current \u001b[38;5;149mVTEX account\u001b[39m.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex logout\u001b[39m"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false}},"args":[]},"publish":{"id":"publish","description":"Publishes the app in the current directory as a release candidate version.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex publish\u001b[39m"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false},"tag":{"name":"tag","type":"option","char":"t","description":"Adds the specified tag to the release."},"workspace":{"name":"workspace","type":"option","char":"w","description":"Uses the specified \u001b[38;5;149mworkspace\u001b[39m in the app registry."},"force":{"name":"force","type":"boolean","char":"f","description":"Publishes the app independently of SemVer rules.","allowNo":false},"yes":{"name":"yes","type":"boolean","char":"y","description":"Answers yes to all prompts.","allowNo":false}},"args":[]},"release":{"id":"release","description":"(Only for git users) Bumps the app version, commits, and pushes to remote the app in the current directory.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex release\u001b[39m","\u001b[38;5;205mvtex release\u001b[39m patch","\u001b[38;5;205mvtex release\u001b[39m patch beta","\u001b[38;5;205mvtex release\u001b[39m minor stable","\u001b[38;5;205mvtex release\u001b[39m pre"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false}},"args":[{"name":"releaseType","description":"Release type.","required":false,"options":["pre","major","minor","patch","prerelease"],"default":"patch"},{"name":"tagName","description":"Tag name.","required":false,"options":["stable","beta","hkignore"],"default":"beta"}]},"setup":{"id":"setup","description":"Sets up typings and tools for the current development environment.","pluginName":"vtex","pluginType":"core","aliases":[],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false},"ignore-linked":{"name":"ignore-linked","type":"boolean","char":"i","description":"Sets up types from published apps while ignoring types from linked apps.","allowNo":false},"all":{"name":"all","type":"boolean","description":"Sets up all available typings, configs, and tools.","allowNo":false},"typings":{"name":"typings","type":"boolean","description":"Sets up GraphQL and React typings.","allowNo":false},"tooling":{"name":"tooling","type":"boolean","description":"Sets up Prettier, Husky, and ESLint.","allowNo":false},"tsconfig":{"name":"tsconfig","type":"boolean","description":"Sets up React and Node TSconfig, if applicable.","allowNo":false}},"args":[]},"switch":{"id":"switch","description":"Switches to another \u001b[38;5;149mVTEX account.\u001b[39m","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex switch\u001b[39m storecomponents"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false},"workspace":{"name":"workspace","type":"option","char":"w","description":"Moves to the specified \u001b[38;5;149mworkspace.\u001b[39m"}},"args":[{"name":"account","description":"\u001b[38;5;149mAccount\u001b[39m name to log in.","required":true}]},"undeprecate":{"id":"undeprecate","description":"Reestablishes a deprecated version of an app as a stable version.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex undeprecate\u001b[39m vtex.service-example@0.0.1"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false},"yes":{"name":"yes","type":"boolean","char":"y","description":"Answers yes to all prompts.","allowNo":false}},"args":[{"name":"appId","description":"Name and version of the app \u001b[38;5;149m({vendor}.{appname}@{x.x.x})\u001b[39m to undeprecate.","required":false},{"name":"ithAppId","description":"Names and versions of the multiple apps \u001b[38;5;149m({vendor}.{appname}@{x.x.x})\u001b[39m to undeprecate.","required":false}]},"uninstall":{"id":"uninstall","description":"Uninstalls an app from the current \u001b[38;5;149mworkspace.\u001b[39m If not specified which app to uninstall, it defaults to the app in the current directory.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex uninstall\u001b[39m","\u001b[38;5;205mvtex uninstall\u001b[39m vtex.service-example","\u001b[38;5;205mvtex uninstall\u001b[39m vtex.service-example@0.x"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false},"yes":{"name":"yes","type":"boolean","char":"y","description":"Answers yes to all prompts.","allowNo":false}},"args":[{"name":"appName","description":"Name of the app to uninstall.","required":false},{"name":"ithAppName","description":"Names of the multiple apps to uninstall.","required":false}]},"unlink":{"id":"unlink","description":"Unlinks an app from the current \u001b[38;5;149mworkspace.\u001b[39m If not specified which app to unlink, it defaults to the app in the current directory.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex unlink\u001b[39m","\u001b[38;5;205mvtex unlink\u001b[39m vtex.service-example@0.x"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false},"all":{"name":"all","type":"boolean","char":"a","description":"Unlinks all apps.","allowNo":false}},"args":[{"name":"appId","description":"Name of the app to unlink.","required":false},{"name":"ithAppId","description":"Names of multiple apps to unlink.","required":false}]},"update":{"id":"update","description":"Updates all installed apps to the latest (minor or patch) version. Does not upgrade to another major version.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex update\u001b[39m"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false}},"args":[]},"local:token":{"id":"local:token","description":"Prints the \u001b[38;5;149muser's auth token\u001b[39m and copies it to the clipboard.","pluginName":"vtex","pluginType":"core","aliases":[],"examples":["\u001b[38;5;205mvtex local token\u001b[39m"],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Shows debug level logs.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Shows this help message.","allowNo":false},"trace":{"name":"trace","type":"boolean","description":"Ensures all requests to \u001b[38;5;149mVTEX IO\u001b[39m are traced.","allowNo":false}},"args":[]}}}