Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vtex/cli-plugin-redirects) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
VTEX CLI Plugin Redirects
Extend the vtex
toolbelt!
Developing
- Clone
vtex/toolbelt
and follow the steps on the Contributing section. - Clone/Create a plugin with this template.
- Change the template name under this project's
package.json
. - Run
yarn link
on this project. - Now run
vtex link @vtex/cli-plugin-template
(or the new name) on thevtex/toolbelt
project. - Run
yarn watch
on thevtex/toolbelt
- Test the command on a VTEX IO app with
vtex-test hello
For more information, read Ocliff Docs.
Usage
$ npm install -g @vtex/cli-plugin-redirects
$ oclif-example COMMAND
running command...
$ oclif-example (-v|--version|version)
@vtex/cli-plugin-redirects/1.0.1 linux-x64 node-v20.17.0
$ oclif-example --help [COMMAND]
USAGE
$ oclif-example COMMAND
...
Commands
oclif-example redirects:delete CSVPATH
oclif-example redirects:export CSVPATH
oclif-example redirects:import CSVPATH
oclif-example redirects:delete CSVPATH
Deletes redirects from the current [38;5;149maccount[39m and [38;5;149mworkspace[39m.
USAGE
$ oclif-example redirects:delete CSVPATH
ARGUMENTS
CSVPATH CSV file containing the URL paths to delete.
OPTIONS
-h, --help Shows this help message.
-v, --verbose Shows debug level logs.
--trace Ensures all requests to VTEX IO are traced.
EXAMPLE
vtex redirects delete csvPath
See code: build/commands/redirects/delete.ts
oclif-example redirects:export CSVPATH
Exports all redirects defined in the current [38;5;149maccount[39m and [38;5;149mworkspace[39m to a CSV file.
USAGE
$ oclif-example redirects:export CSVPATH
ARGUMENTS
CSVPATH Name of the CSV file.
OPTIONS
-h, --help Shows this help message.
-v, --verbose Shows debug level logs.
--trace Ensures all requests to VTEX IO are traced.
EXAMPLE
vtex redirects export csvPath
See code: build/commands/redirects/export.ts
oclif-example redirects:import CSVPATH
Imports redirects from a CSV file to the current [38;5;149maccount[39m and [38;5;149mworkspace[39m.
USAGE
$ oclif-example redirects:import CSVPATH
ARGUMENTS
CSVPATH Name of the CSV file.
OPTIONS
-h, --help Shows this help message.
-r, --reset Removes all redirects previously defined.
-v, --verbose Shows debug level logs.
--trace Ensures all requests to VTEX IO are traced.
EXAMPLE
vtex redirects import csvPath
See code: build/commands/redirects/import.ts