@sitecore/sxa-cli
v10.4.0
Published
SXA CLI for theme
Downloads
414
Readme
For using Autosynchronizer, you need to complete next steps:
- Open PathToInstance/Website/App_Config/Include/z.Feature.Overrides (in previous version of Sitecore it can be PathToInstance/Website/App_Config/Include/Feature) folder and remove .disabled from z.SPE.Sync.Enabler.Gulp.config.disabled file;
| command | alias | options | description |
| :----------------------- | :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| sxa init
| sxa i
| - | Download all necessary files for compatibility with Creative Exchange Live Mode. This process will not replace existing files only download the missing ones. |
| sxa new [themeName]
| sxa n
| --url <url>
- Url to the instance where the theme should be created. You don't have to specify the URL if you want to create the theme in the currently registered Sitecore instance. | Creates a theme both locally and within your Sitecore instance. Use this command to create a new theme for your site. |
| sxa register <url>
| sxa reg
| - | Specifies the default Sitecore instance for the "init" and "new" commands for your working environment. Only one instance can be registered as the default at a time. |
| sxa get-url
| sxa g
| - | Returns the current default Sitecore instance URL for the "init" and "new" commands. |
| sxa config [themeName]
| sxa c
| - | Sets up a theme configuration variable by answering a list of questions. Use this command to change the theme configuration. |
| sxa build [taskName]
| sxa b
| -d, --debug
- provides additional debugging information | Builds theme assets based on the current theme configuration |
| sxa upload [taskName]
| sxa u
| 1. -d, --debug
provides additional debugging information; 2. -l, --login <login>
- Login for uploading; 3. -p, --password <password>
- Password for uploading | Upload theme assets based on the theme configuration |
| sxa watch [taskName]
| sxa w
| 1. -d, --debug
- provides additional debugging information; 2. -l, --login <login>
- Login for watching; 3. -p, --password <password>
- Password for watching | Watches for theme asset changes on the drive and uploads any modified files automatically. Can be configured with "sxa config" command |
| sxa rebuild [taskName]
| sxa r
| 1. -d, --debug
- provides additional debugging information; 2. -l, --login <login>
- Login for watching; 3. -p, --password <password>
- Password for watching | rebuild and upload theme assets |
List of build
tasks:
Global tasks
build All
- compiles sass, minifies css and js;
For SASS
build Sass
- compiles sass into css from root of sass folder;build SassStyles
- compiles files from sass/styles/common , sass/styles/content-alignment , sass/styles/layout to styles/styles.css;
For CSS
build Css
- bundles and minifies files in styles folder;
For JavaScript:
build Eslint
- run eslint for all JavaScript in the Scripts folder;build Js
- bundles and minifies JavaScript files in the Scripts folder;
For SASS and CSS
build Styles
- compiles sass components into css, bundles and minfies css files;
For Sprite
build SpriteFlag
- to create sprite for flags;
List of upload
tasks:
Global tasks:
upload All
- uploading JavaScript, CSS, and images to the Sitecore instance;
For CSS
upload Css
- uploading CSS files from styles folder based on the theme configuration.
For JavaScript:
upload Js
- uploading JavaScript files from Scripts folder based on the theme configuration
For SASS and CSS
upload Img
- upload files from images to the Sitecore instance;
For Fonts
upload Fonts
- upload files from Fonts folder to the Sitecore instance;
For Gulp config
upload GulpConfig
- uploading config folder and gulpfilejs
List of rebuild tasks:
Global tasks:
rebuild All
- compiles sass components into css, minifies js and css, uploads js, css, images;rebuild Main
- compiles sass components into css, minifies js and css, uploads js, css;
List of watch tasks:
Global tasks:
sxa watch All
- aggregates the functionality of the following tasks:watch Sass
watch JS
watch Es
watch Css
watch Img
watch SassSource
watch Scriban
watch Html
For Sass:
watch Sass
- run a list of tasks:watch SassComponents
watch SassBase
watch SassStyles
watch SassDependency
watch SassStyles
- monitors changes under sass/styles/common , sass/styles/content-alignment , sass/styles/layout folders, compiles all of them to styles/styles.css;watch SassBase
- monitors changes under sass/abstracts/, sass/base/ , sass/components folders and compiles components and styles;watch SassComponents
- monitors changes in component stylesunder sass folder and compiles them to styles folder;watch SassDependency
- monitors changes under sass/styles (except for sass/styles/common , sass/stylescontent-alignment , sass/styles/layout) and compilesappropriate components;watch SassSource
- monitors changed under sass/* folderand uploads changed file to the Sitecore instance;
For CSS
watch Css
- monitors changes of css files under styles folder and uploads them to the Sitecore instance;
For JavaScript:
watch Js
- watch on changes of js files under Scripts folder and upload them to the Sitecore instance;watch Es
- watch on changes of js files under sources folder and upload them to the Sitecore instance;
For Images
watch Img
- monitors changes under images folder and uploads the files to the Sitecore instance;
Creative Exchange specific tasks
For HTML
watch Html
- monitors changes of HTML files and uploads them to the Sitecore instance to be parsed by Creative Exchange;
For Scriban
watch Scriban
- monitors changes of Scriban files and uploads them to the Sitecore instance;