Guide applies to: modern

CLI Reference

This guide is a reference of the Open Tooling CLI commands available through ExtGen and its underlying tools.

ext-gen app CLI - Application Generation

Ext JS open tooling requires NodeJS and Java.

App Generation CLI Options

Here’s a list of the CLI options you could use to generate your application.

Example:

ext-gen app (-h) (-d) (-i) (-t 'template') (-m 'moderntheme') (-c 'classictheme') (-n 'name') (-f 'folder')

Available App Templates

There are several app templates to generate your application from. Set the --template property with one of the options below.

Example:

ext-gen app --template universalmodern --moderntheme theme-material --name CoolUniversalApp

Available Themes

These themes are available in the ext-gen app generation. Set the --classictheme or --moderntheme properties with one of the options below.

Example:

ext-gen app --template universalmodern --moderntheme theme-material --name CoolUniversalApp

ext-gen migrate - Application Migration

ExtGen’s migrate command is a helpful utility that will migrate an existing ExtJS application built with Sencha Cmd to an ExtJS application that uses Open Tooling (ExtGen).

ext-gen migrate

Full documentation on ext-gen migrate can be found here.

ext-build CLI

ExtBuild provides Sencha Cmd functionality in Sencha’s npm projects. Requires Node and Java.

Installation

1. Install npm (we assume you have pre-installed node.js).
2. npm install -g @sencha/ext-build

Usage

CLI Reference

Structure

ext-build generate app (sdk) (template) (name) (path)\ ext-build generate viewpackage (profile) (viewname)

Examples

// Generate an application, specifying the SDK version and template
ext-build generate app --sdk 'Ext/ext-7.0.0' --template 'universalmodern' MyApp ./MyApp
// Generate an application, specifying the SDK version and template
ext-build gen app -s 'Ext/ext-7.0.0' -t 'universalmodern' MyApp ./MyApp
eb g a -s 'Ext/ext-7.0.0' -t 'universalmodern' MyApp ./MyApp
// Generate a new viewpackage named "settings" for the desktop build profile (configured in app.json) in an existing application
ext-build generate viewpackage desktop settings
// Generate a new viewpackage named "detail" for the phone build profile (configured in app.json) in an existing application
ext-build generate viewpackage phone detail

For Command line help:

ext-build or eb

Driving Sencha Cmd Directly with npx

The feature rich ecosystem many ExtJS users are familiar, Sencha Cmd, is still available in an ExtGen application.

Investigating the @sencha packages inside of your node_modules, you will see Sencha Cmd among other framework packages. Open up the cmd package and you’ll find the Sencha Cmd binary. How do you use this binary from your application?

First, if you are familiar with Sencha Cmd you will recall that during installation you probably added Sencha Cmd to your $PATH, wich the binary typically being installed in your user bin directory. An Npm project also has a bin, located at node_modules/.bin. Inside of this folder you will see the binaries made available to your project through npm.

The npm community has created the npx package. Npx will check whether the requested binary is available via your $PATH or if it’s available within your project’s node_modules/.bin.

To take advantage of old workflows, to or harness additional Sencha horsepower, you can use the npx package + sencha cmd CLI syntax directly from the root of your ExtGen application.

Npx Examples

app watch

// Sencha Cmd
sencha app watch desktop
// Npx + Sencha Cmd
npx sencha app watch desktop

compile

// Sencha Cmd
sencha compile -classpath=js exclude -not -namespace Ext and concat ext-all-dev.js
// Npx + Sencha Cmd
npx sencha compile -classpath=js exclude -not -namespace Ext and concat ext-all-dev.js

Summary

In brief, nearly all of the same Sencha Cmd functionaly you may be previously used to can still be accessed by simply prepending your Sencha Cmd CLI syntax with the npx directive.