Ext.data.JsonP.command_reference({"title":"Sencha Cmd Reference","guide":"

sencha

\n
\n

Contents

\n
    \n
  1. sencha ant
  2. \n
  3. sencha app
  4. \n
  5. sencha app build
  6. \n
  7. sencha app package
  8. \n
  9. sencha app package build
  10. \n
  11. sencha app package generate
  12. \n
  13. sencha app package run
  14. \n
  15. sencha app refresh
  16. \n
  17. sencha app resolve
  18. \n
  19. sencha app upgrade
  20. \n
  21. sencha build
  22. \n
  23. sencha compass
  24. \n
  25. sencha compile
  26. \n
  27. sencha compile concatenate
  28. \n
  29. sencha compile exclude
  30. \n
  31. sencha compile include
  32. \n
  33. sencha compile intersect
  34. \n
  35. sencha compile metadata
  36. \n
  37. sencha compile page
  38. \n
  39. sencha compile pop
  40. \n
  41. sencha compile push
  42. \n
  43. sencha compile restore
  44. \n
  45. sencha compile save
  46. \n
  47. sencha compile show-ignored
  48. \n
  49. sencha compile union
  50. \n
  51. sencha config
  52. \n
  53. sencha fs
  54. \n
  55. sencha fs concatenate
  56. \n
  57. sencha fs difference
  58. \n
  59. sencha fs minify
  60. \n
  61. sencha fs mirror
  62. \n
  63. sencha fs mirror all
  64. \n
  65. sencha fs mirror image
  66. \n
  67. sencha fs mirror sprite
  68. \n
  69. sencha fs slice
  70. \n
  71. sencha fs web
  72. \n
  73. sencha fs web start
  74. \n
  75. sencha fs web stop
  76. \n
  77. sencha generate
  78. \n
  79. sencha generate app
  80. \n
  81. sencha generate controller
  82. \n
  83. sencha generate form
  84. \n
  85. sencha generate model
  86. \n
  87. sencha generate package
  88. \n
  89. sencha generate profile
  90. \n
  91. sencha generate theme
  92. \n
  93. sencha generate view
  94. \n
  95. sencha generate workspace
  96. \n
  97. sencha help
  98. \n
  99. sencha io
  100. \n
  101. sencha io app-set-group
  102. \n
  103. sencha io create-app
  104. \n
  105. sencha io create-auth-group
  106. \n
  107. sencha io create-version
  108. \n
  109. sencha io deploy
  110. \n
  111. sencha io list-apps
  112. \n
  113. sencha io list-groups
  114. \n
  115. sencha io list-versions
  116. \n
  117. sencha io set-group-auth
  118. \n
  119. sencha io undeploy
  120. \n
  121. sencha iofs
  122. \n
  123. sencha iofs get
  124. \n
  125. sencha iofs ls
  126. \n
  127. sencha iofs put
  128. \n
  129. sencha iofs rm
  130. \n
  131. sencha js
  132. \n
  133. sencha manifest
  134. \n
  135. sencha manifest create
  136. \n
  137. sencha package
  138. \n
  139. sencha package add
  140. \n
  141. sencha package build
  142. \n
  143. sencha package extract
  144. \n
  145. sencha package get
  146. \n
  147. sencha package list
  148. \n
  149. sencha package remove
  150. \n
  151. sencha package repository
  152. \n
  153. sencha package repository add
  154. \n
  155. sencha package repository init
  156. \n
  157. sencha package repository list
  158. \n
  159. sencha package repository remove
  160. \n
  161. sencha package repository show
  162. \n
  163. sencha package repository sync
  164. \n
  165. sencha package upgrade
  166. \n
  167. sencha repository
  168. \n
  169. sencha repository add
  170. \n
  171. sencha repository init
  172. \n
  173. sencha repository list
  174. \n
  175. sencha repository remove
  176. \n
  177. sencha repository show
  178. \n
  179. sencha repository sync
  180. \n
  181. sencha theme
  182. \n
  183. sencha theme build
  184. \n
  185. sencha theme capture
  186. \n
  187. sencha theme slice
  188. \n
  189. sencha upgrade
  190. \n
  191. sencha which
  192. \n
\n
\n\n

sencha ant

\n\n

Invokes the embedded version of Apache Ant providing the cmd.dir property to\naccess Sencha Cmd using the following taskdef:

\n\n
<taskdef resource=\"com/sencha/ant/antlib.xml\"\n         classpath=\"${cmd.dir}/sencha.jar\"/>\n
\n\n

This command recognizes the -Dproperty=value syntax for properties used by\nAnt, even though this does not conform to normal Sencha Cmd parameter syntax.\nSimilar to directly invoking Ant, this command defaults to \"build.xml\" for\nthe script file basing its search on the current directory or the value of the\n-cwd switch passed to sencha.

\n\n

For example, the following command uses \"../build.xml\" as the script and\npasses in the foo property as \"42\" when executing the default target (since\nno target was specified).

\n\n
sencha -cwd=.. ant -Dfoo=42\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha ant [options] targets...\n
\n\n

Where:

\n\n\n\n\n

sencha app

\n\n

This category contains various commands for application management.

\n\n

Categories

\n\n\n\n\n

Commands

\n\n\n\n\n

sencha app build

\n\n

This command builds the current application.

\n\n
sencha app build [production|testing|native|package]\n
\n\n

This will build your application in its current configuration and generate the\nbuild output in the \"build/<environment>\" folder. This location and many\nother properties can be configured in your application's configuration file\n\".sencha/app/sencha.cfg\" or the provided build script \"build.xml\".

\n\n

For locally overriding build properties, the build script loads an optional\nproperties file called \"local.properties\" if present in your app folder. The\npurpose of this file is to define build properties that are in some way special\nto the local environment (that is, the local machine). As such, this file is\nnot intended to be tracked in source control.

\n\n

Using Ant

\n\n

This command is equivalent to running the provided Ant script directly using\nthe following command:

\n\n
sencha ant [production|testing|native|package] build\n
\n\n

To tune the process, start by looking at the generated \"build.xml\" in your\napp folder. The actual build logic is located in \".sencha/app/build-impl.xml\".

\n\n

The \"build.xml\" script can be used by many Continuous Integration (CI) systems\nif they understand Apache Ant (most do). If not, the Sencha Cmd command line\ncan be used as you would during development. If the CI system understands Ant,\nhowever, it is often more convenient to use that integration rather than using\na command line invocation.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha app build [options] [environment] \\\n                           [destination] \\\n                           [archive]\n
\n\n

sencha app package

\n\n

This category contains various commands for packing application for deployment\non phones using the Sencha Mobile Packager.

\n\n

Commands

\n\n\n\n\n

sencha app package build

\n\n

This command creates a native package of the current application.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha app package build [options] path\n
\n\n

sencha app package generate

\n\n

This command generates a Packager configuration JSON file.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha app package generate [options] path\n
\n\n

sencha app package run

\n\n

This command packages and runs the current application.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha app package run [options] path\n
\n\n

sencha app refresh

\n\n

This command regenerates the metadata file containing \"bootstrap\" data for the\ndynamic loader and class system.

\n\n

This must be done any time a class is added, renamed or removed.

\n\n

This command can also update any required packages if you have added package\nrequirements to your application. To refresh required packages (which may\ndownload those packages from remote repositories), do this:

\n\n
sencha app refresh --packages\n
\n\n

The additional parameters are seldom used.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha app refresh [options] [metadata-file] \\\n                             [base-path]\n
\n\n

sencha app resolve

\n\n

Generate a list of dependencies in the exact loading order for the current\napplication.

\n\n

NOTE: the resolved paths are relative to the current application's HTML file.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha app resolve [options] uri \\\n                             output-file\n
\n\n

sencha app upgrade

\n\n

This command upgrades the current application (based on current directory) to a\nspecified new framework.

\n\n
sencha app upgrade /path/to/sdk\n
\n\n

NOTE: This will upgrade the framework used by the current application in the\ncurrent workspace. This will effect any other applications in this workspace\nusing the same framework (i.e., \"ext\" or \"touch\").

\n\n

To upgrade just the generate scaffolding of your application to a new version\nof Sencha Cmd and not the framework in use, do this:

\n\n
sencha app upgrade --noframework\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha app upgrade [options] [path]\n
\n\n

sencha build

\n\n

This command is used to process a legacy JSBuilder (\"jsb\") file.

\n\n

DEPRECATED: This command is provided for backwards compatibility with previous\nreleases. It is highly recommended to migrate applications to the new compile\ncommand and discontinue use of this command.

\n\n

Syntax

\n\n
sencha build \n
\n\n

sencha compass

\n\n

Options

\n\n\n\n\n

sencha compile

\n\n

This command category provides JavaScript compilation commands. The compile\ncategory maintains compilation state across its sub-commands so using and to\nconnect sub-commands can provide significant time savings compared to making\nrepeated calls.

\n\n

Options

\n\n\n\n\n

Commands

\n\n\n\n\n

sencha compile concatenate

\n\n

This command writes the current set to the specified output file.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha compile concatenate [options] output-file\n
\n\n

sencha compile exclude

\n\n

This command removes from the current set any files matching the criteria.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha compile exclude [options] \n
\n\n

sencha compile include

\n\n

This command adds the files matching the criteria to the current set.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha compile include [options] \n
\n\n

sencha compile intersect

\n\n

This command produces as in the current set the files that are contained in all\nof the specified input sets. Alternatively, this command can include files that\nare present in a present in a certain minimum number of sets.

\n\n

This command only operates on saved sets (unlike most other set operations).

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha compile intersect [options] \n
\n\n

sencha compile metadata

\n\n

This command generates various forms of metadata extracted from the current set\nof files. This data can be exported in various formats (e.g., JSON or JSONP).

\n\n

Options

\n\n

Data Type

\n\n

Choose one of the following options

\n\n\n\n\n

Format

\n\n

Choose one of the following options

\n\n\n\n\n

Misc

\n\n\n\n\n

Syntax

\n\n
sencha compile metadata [options] \n
\n\n

sencha compile page

\n\n

This command processes a markup file as input and generates an output file with\ncertain sections rewritten.

\n\n

If the -name option is specified, the dependency graph of all required files\nis saved as a file set with that name (see also the save command).

\n\n

If the -name option is not specified, all required files are instead written\nto the \"all-classes.js\" file.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha compile page [options] output-page\n
\n\n

sencha compile pop

\n\n

This command restores the current set of files from the \"stack\". This state was\npreviously put on the \"stack\" using the push command.

\n\n
sencha compile ... \\\n            and push \\\n            and ... \\\n            and pop\n            and ...\n
\n\n

Between the push and pop commands the current file set can be adjusted as\nneeded and then restored for subsequent commands.

\n\n

Syntax

\n\n
sencha compile pop \n
\n\n

sencha compile push

\n\n

This command saves the current set of files on a \"stack\" to easily save and\nrestore state.

\n\n
sencha compile ... \\\n            and push \\\n            and ... \\\n            and pop\n            and ...\n
\n\n

Between the push and pop commands the current file set can be adjusted as\nneeded and then restored for subsequent commands.

\n\n

Syntax

\n\n
sencha compile push \n
\n\n

sencha compile restore

\n\n

Syntax

\n\n
sencha compile restore String\n
\n\n

sencha compile save

\n\n

Syntax

\n\n
sencha compile save String\n
\n\n

sencha compile show-ignored

\n\n

Displays a list of all files found in the classpath but matching an -ignore\ncriteria.

\n\n

Syntax

\n\n
sencha compile show-ignored \n
\n\n

sencha compile union

\n\n

This command adds files matching the criteria to the current set. This is\nsimilar to the include command except that this command first removes all\nfiles from the current set. In other words, this command makes the current set\nequal to only those files that match the criteria.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha compile union [options] \n
\n\n

sencha config

\n\n

This command can be used to either set configuration options singly or load a\nconfiguration file to set multiple options.

\n\n

Because these configuration options are only held for the current execution of\nSencha Cmd, you will almost always use then to chain commands that will now\nbe executed with the modified configuration.

\n\n

For example, to change the theme of an Ext JS application for a build:

\n\n
sencha config -prop app.theme=ext-theme-neptune then app build\n
\n\n

Multiple properties can be loaded from a properties file:

\n\n
sencha config -file neptune.properties then app build\n
\n\n

The content of \"neptune.properties\" might be something like this:

\n\n
app.theme=ext-theme-neptune\napp.build.dir=${app.dir}/build/neptune\n
\n\n

In this case, an alternative would be to set app.dir in the applications's\n\"sencha.cfg\" file like so:

\n\n
app.build.dir=${app.dir}/build/${app.theme}\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha config [options] \n
\n\n

sencha fs

\n\n

This category provides commands for manipulating files.

\n\n

Categories

\n\n\n\n\n

Commands

\n\n\n\n\n

sencha fs concatenate

\n\n

This command combines multiple input files into a single output file.

\n\n
sencha fs concat -to=output.js input1.js input2.js input3.js\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha fs concatenate [options] files...\n
\n\n

sencha fs difference

\n\n

This command produces a delta (or \"patch\") file between input files.

\n\n
sencha fs diff -from=base.js -to=modified.js -delta=patch\n
\n\n

Syntax

\n\n
sencha fs difference \n
\n\n

sencha fs minify

\n\n

This command produced minified files using various back-end compressors.

\n\n
sencha fs minify -yui -from=in.js -to=out.js\n\nsencha fs minify -closure -from=in.js -to=out.js\n
\n\n

The legacy syntax is also supported:

\n\n
sencha fs minify -compressor=yuicompressor -from=in.js -to=out.js\n\nsencha fs minify -compressor=closurecompiler -from=in.js -to=out.js\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha fs minify [options] \n
\n\n

sencha fs mirror

\n\n

Commands for create horizontal mirror of images and sprites for RTL locales.

\n\n

This family of commands is intended for automated production of \"derivative\"\nimages based on hand maintained and designed image assets authored in the more\nfamiliar, left-to-right (LTR) form.

\n\n

Commands

\n\n\n\n\n

sencha fs mirror all

\n\n

This command creates horizontal mirror images of a folder of images and/or\nsprites. This command requires some name consistency in order to differentiate\noutput files from input files and the geometry of sprites.

\n\n

Sprites must have a name segment that looks like \"4x3\" to define its geometry.\nThis is understood as \"columns\" x \"rows\" or, in this example, 4 columns and 3\nrows.

\n\n

The following examples all fit this pattern:

\n\n\n\n\n

The input files and output files are separated by a suffix that must be given.\nTHe output files will be produced from the input files applying the suffix. By\ndefault, the output files are written to the same folder as the input files.\nThis can be changed by specifying \"-out\".

\n\n

For example:

\n\n
sencha fs mirror all -r -suffix=-rtl /path/to/images\n
\n\n

The above command performs the following:

\n\n\n\n\n

By passing the -format switch, the format of the output images can be set\nto be other than the same format as the original file. For example, one could\nconvert PNG files to GIF by passing -format=gif. This does only basic image\nconversion and no advanced image processing. Simple color quantization can be\nenabled using -quantize.

\n\n

For example:

\n\n
sencha fs mirror all all -format=gif -ext=png -quantize -out=/out/dir \\\n     -suffix=-rtl /some/pngs\n
\n\n

The above command will process all \"png\" images and will write out their\n\"gif\" versions (using color quantization) to a different folder.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha fs mirror all [options] File\n
\n\n

Where:

\n\n\n\n\n

sencha fs mirror image

\n\n

This command create a horizontal mirror image of a given input file.

\n\n

For example

\n\n
sencha fs mirror image foo.png foo-rtl.png\n
\n\n

The above command creates \"foo-rtl.png\" from \"foo.png\".

\n\n

Syntax

\n\n
sencha fs mirror image File \\\n                       File\n
\n\n

sencha fs mirror sprite

\n\n

This command create a horizontal mirror image of the cells in a given sprite.

\n\n

For example

\n\n
sencha fs mirror sprite -rows=2 -cols=4 sprite.png sprite-rtl.png\n
\n\n

The above command horizontally flips each cell in the 2x4 sprite \"sprite.png\"\nand produces \"sprite-rtl.png\".

\n\n

NOTE: The number of rows and columns are required.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha fs mirror sprite [options] File \\\n                                  File\n
\n\n

sencha fs slice

\n\n

This command performs image slicing and manipulation driven by the contents of\na JSON manifest file. The manifest file contains an array of image area\ndefinitions that further contain a set of \"slices\" to make.

\n\n

This file and the corresponding image are typically produced for a Theme as\npart of the theme package build. For details on this process, consult this\nguide:

\n\n

http://docs.sencha.com/ext-js/4-2/#!/guide/command_slice

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha fs slice [options] \n
\n\n

sencha fs web

\n\n

This category provides commands to manage a simple HTTP file server.

\n\n

Options

\n\n\n\n\n

Commands

\n\n\n\n\n

sencha fs web start

\n\n

This command starts the Web server and routes requests to the specified files.\nFor example:

\n\n
sencha fs web -port 8000 start -map foo=/path/to/foo,bar=/another/path\n
\n\n

Given the above, the following URL entered in a browser will display the files\nin \"/path/to/foo\":

\n\n
http://localhost:8000/foo\n
\n\n

And this URL will display the files in \"/another/path\":

\n\n
http://localhost:8000/bar\n
\n\n

To stop the server, press CTRL+C or run the sencha fs web stop command:

\n\n
sencha fs web -port 8000 stop\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha fs web start [options] \n
\n\n

sencha fs web stop

\n\n

This command stops the Web server previously started by sencha fs web start.

\n\n

For example:

\n\n
sencha fs web -port 8000 start -map foo=/path/to/foo,bar=/another/path\n
\n\n

From another terminal or console, this will stop the server:

\n\n
sencha fs web -port 8000 stop\n
\n\n

Syntax

\n\n
sencha fs web stop \n
\n\n

sencha generate

\n\n

This category contains code generators used to generate applications as well\nas add new classes to the application.

\n\n

Commands

\n\n\n\n\n

sencha generate app

\n\n

This command generates an empty application given a name and target folder.

\n\n

The application can be extended using other sencha generate commands (e.g.,\nsencha generate model).

\n\n

Other application actions are provided in the sencha app category (e.g.,\nsencha app build).

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha generate app [options] name \\\n                              path\n
\n\n

sencha generate controller

\n\n

This command generates a new Controller and adds it to the current application.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha generate controller [options] name\n
\n\n

sencha generate form

\n\n

This command generates a new form and adds it to the current application.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha generate form [options] name \\\n                               fields \\\n                               [xtype]\n
\n\n

sencha generate model

\n\n

This command generates a new Model class and adds it to the current application.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha generate model [options] name \\\n                                fields\n
\n\n

sencha generate package

\n\n

This command generates a new Sencha Cmd Package. A package is in many ways like\nan application in that it contains any of the following pieces:

\n\n\n\n\n

All of these are integrated by a build process using sencha package build.

\n\n

For example:

\n\n
sencha generate package foo\n
\n\n

To use this package in applications (or other packages), you just add the name\nof the package to the requires array in the \"app.json\" or \"package.json\"\nfile:

\n\n
requires: [\n    'foo'\n]\n
\n\n

All packages reside in the \"./packages\" folder of the workspace (which is\noften the same folder as your application).

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha generate package [options] name\n
\n\n

sencha generate profile

\n\n

This command generates a new Profile and adds it to the current application.

\n\n

NOTE: Sencha Touch only.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha generate profile [options] name\n
\n\n

sencha generate theme

\n\n

This command generates a new Theme. For Ext JS 4.1, themes are \"owned\" by an\napplication. In Ext JS 4.2 and beyond, themes are Packages.

\n\n

In Ext JS 4.2, theme packages can extend other themes. By default, generated\nthemes extend \"ext-theme-classic\". This can be overridden using --extend.

\n\n

To generate a stand-alone Theme in Ext JS 4.2, follow these steps. Generate a\nworkspace (with \"ext\" folder) using Ext JS 4.2 SDK unzipped on your system:

\n\n
sencha -sdk /path/to/ext-4.2.0 generate workspace MyWorkspace\ncd MyWorkspace\n
\n\n

From inside the workspace, use the \"ext\" folder to generate the theme package:

\n\n
sencha -sdk ext generate theme --extend ext-theme-neptune MyTheme\n
\n\n

The above could equivalently have used the SDK used to create the workspace.

\n\n

The -sdk switch is used here to indicate the framework on which the theme is\nbased. This is not needed if the command is run from an Ext JS application\nfolder.

\n\n

NOTE: Does not apply to Sencha Touch.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha generate theme [options] name\n
\n\n

sencha generate view

\n\n

This command generates a new View class and adds it to the current application.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha generate view [options] name\n
\n\n

sencha generate workspace

\n\n

This command generates a workspace for managing shared code across pages or\napplications.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha generate workspace [options] [path]\n
\n\n

sencha help

\n\n

This command displays help for other commands.

\n\n

Example

\n\n
sencha help generate app\n
\n\n

Syntax

\n\n
sencha help command...\n
\n\n

Where:

\n\n\n\n\n

sencha io

\n\n

These commands give you access to all the tools required to create, manage and\ndeploy web applications in the io cloud.

\n\n

Sencha.io provides a backend-as-a-service that enables developers with a set of\nAPIs that helps them build and run their applications. It allows you to build\nweb applications using services provided through our client side SDKs, Ext JS\nand Sencha Touch.

\n\n

Commands

\n\n\n\n\n

sencha io app-set-group

\n\n

Sets the Authentication Group which is associated with this Application.

\n\n

Only one Authentication Group may be associated with an Application at any\ngiven time.

\n\n

An Authentication Group controls which methods of authentication are available\nto users of your application. Users are members of Authentication Groups.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha io app-set-group [options] [appName] \\\n                                  [groupName] \\\n                                  [username] \\\n                                  [password] \\\n                                  [teamName]\n
\n\n

sencha io create-app

\n\n

Creates a new Application in the context of Sencha Io.

\n\n

Syntax

\n\n
sencha io create-app [appName] \\\n                     [username] \\\n                     [password] \\\n                     [teamName]\n
\n\n

sencha io create-auth-group

\n\n

Creates a new Authentication Group in Sencha Io.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha io create-auth-group [options] [groupName] \\\n                                      [username] \\\n                                      [password] \\\n                                      [teamName]\n
\n\n

sencha io create-version

\n\n

Creates a new Version of an Application. In doing so, an application \".zip\"\nfile is uploaded to the cloud, along with a version tag and a description of\nthis version. Once a version has been successfully created, it must be\ndeployed before it can be accessed.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha io create-version [options] [appName] \\\n                                   [packagePath] \\\n                                   [versionTag] \\\n                                   [versionDescription] \\\n                                   [username] \\\n                                   [password] \\\n                                   [teamName]\n
\n\n

sencha io deploy

\n\n

Deploys a previously created version of an Application to the cloud.

\n\n

Once an application has been deployed, it becomes publicly accessible.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha io deploy [options] [appName] \\\n                           [versionTag] \\\n                           [username] \\\n                           [password] \\\n                           [teamName]\n
\n\n

sencha io list-apps

\n\n

Lists all Applications which are accessible by this Developer (in the current\nTeam context).

\n\n

If the Developer is a member of multiple teams, they may have to switch Team\ncontexts to see all of the Applications to which they have access.

\n\n

Syntax

\n\n
sencha io list-apps [username] \\\n                    [password] \\\n                    [teamName]\n
\n\n

sencha io list-groups

\n\n

Lists all the Authentication Groups to which this Developer currently has\naccess.

\n\n

If the Developer is a member of multiple teams, they may have to switch Team\ncontexts to see all of the Authentication Groups to which they have access.

\n\n

Syntax

\n\n
sencha io list-groups [username] \\\n                      [password]\n
\n\n

sencha io list-versions

\n\n

Lists all of the currently uploaded versions of an Application in the system.

\n\n

Syntax

\n\n
sencha io list-versions [appName] \\\n                        [username] \\\n                        [password] \\\n                        [teamName]\n
\n\n

sencha io set-group-auth

\n\n

Sets an Authentication Group's configuration.

\n\n

Acceptible values for Authentication Method are senchaio (which is on by\ndefault), facebook, and twitter.

\n\n

In order to use facebook or twitter, Application Keys and Secrets must be\nobtained for you application with those services, and then be provided as the\nfinal parameters of this command.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha io set-group-auth [options] [groupName] \\\n                                   [authMethod] \\\n                                   [enabled] \\\n                                   [username] \\\n                                   [password] \\\n                                   [key] \\\n                                   [secret]\n
\n\n

sencha io undeploy

\n\n

Undeploys a previously deployed version of an Application.

\n\n

Once this has been done, the application will no longer be publicly available.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha io undeploy [options] [appName] \\\n                             [versionTag] \\\n                             [username] \\\n                             [password] \\\n                             [teamName]\n
\n\n

sencha iofs

\n\n

These commands gives you low level access to an io application's cloud hosting\nthrough an interface which ressembles a file system shell.

\n\n

Commands

\n\n\n\n\n

sencha iofs get

\n\n

Retrieves a remote file from an Application's filesystem in Sencha io.

\n\n

Syntax

\n\n
sencha iofs get [appName] \\\n                [path] \\\n                [username] \\\n                [password] \\\n                [teamName]\n
\n\n

sencha iofs ls

\n\n

Lists the contents of a remote path in an Application's Sencha Io hosting.

\n\n

Syntax

\n\n
sencha iofs ls [appName] \\\n               [path] \\\n               [username] \\\n               [password] \\\n               [teamName]\n
\n\n

sencha iofs put

\n\n

Uploads a local file to a remote path in an Application's Sencha Io hosting.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha iofs put [options] [appName] \\\n                          [path] \\\n                          [localPath] \\\n                          [contentType] \\\n                          [username] \\\n                          [password] \\\n                          [teamName]\n
\n\n

sencha iofs rm

\n\n

Removes a remote directory or file from an Application's remote Sencha Io\nhosting.

\n\n

Syntax

\n\n
sencha iofs rm [appName] \\\n               [path] \\\n               [username] \\\n               [password] \\\n               [teamName]\n
\n\n

sencha js

\n\n

This command loads and executes the specified JavaScript source file or files.

\n\n
sencha js file.js[,file2.js,...] [arg1 [arg2 ...] ]\n
\n\n

Files

\n\n

The first argument to this command is the file or files to execute. If there\nare multiple files, separate them with commas. In addition to the command line\ntechnique of specifying files, this command also recognizes the following\ndirective:

\n\n
//@require ../path/to/source.js\n
\n\n

This form of require directive uses a relative path based on the file that\ncontains the directive. Any given file will only be executed once, in much the\nsame manner as the compiler.

\n\n

Context

\n\n

A primitive console object with the following methods is provided to the\nJavaScript execution context:

\n\n\n\n\n

Arguments beyond the first can be accessed in JavaScript with the global $args\narray. The current directory can be accessed with $curdir.

\n\n

The Sencha Cmd object can be accessed with sencha. This object has a version\nproperty and a dispatch method.

\n\n
if (sencha.version.compareTo('3.0.0.210') < 0) {\n    console.warn('Some message');\n} else {\n    // dispatch any command provided by Cmd:\n    sencha.dispatch([ 'app', 'build', $args[1] ]);\n}\n
\n\n

Beyond the above, the executing JavaScript has full access to the JRE using\nthe importPackage and importClass methods.

\n\n

For example:

\n\n
importPackage(java.io);\n\nvar f = new File('somefile.txt');  // create a java.io.File object\n
\n\n

For further details on the JavaScript engine provided by Java, consult the\nJava Scripting guide:

\n\n

http://docs.oracle.com/javase/6/docs/technotes/guides/scripting/programmer_guide/index.html

\n\n

Syntax

\n\n
sencha js String \\\n          String[]...\n
\n\n

sencha manifest

\n\n

This category provides commands to manage application manifests.

\n\n

Commands

\n\n\n\n\n

sencha manifest create

\n\n

This command generates a list of metadata for all classes.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha manifest create [options] output-path\n
\n\n

sencha package

\n\n

These commands manage packages in the local repository.

\n\n

These commands are not typically used directly because application requirements\nare automatically used by sencha app build and sencha app refresh --packages\nto handle these details.

\n\n

Using Packages

\n\n

The most common commands needed to use packages are those that connect your\nlocal package repository to remote repositories. By default, the local repo has\none remote repository defined that points at Sencha's package repository.

\n\n

To add, remove or display these connections see:

\n\n
sencha help package repo\n
\n\n

Authoring Packages

\n\n

When authoring packages for others to use in their applications, however, these\ncommands are involved. In particular, you must first initialize your local\npackage repository. This is because the local repository is automatically\ninitialized \"anonymously\". In this state, the local repository can only be used\nto retrieve and cache other packages. To create and publish packages, the local\nrepository must be initialized with a name and an optional email address.

\n\n

This name is not required to be globally unique, but it is a good idea to use a\nname that is unique and meaningful as a package author.

\n\n
sencha repository init -name \"My Company, Inc.\"\n\nsencha repository init -name mySenchaForumId\n
\n\n

For details see:

\n\n
sencha help repository init\n
\n\n

Categories

\n\n\n\n\n

Commands

\n\n\n\n\n

sencha package add

\n\n

Adds a new package file (\"*.pkg\") to the local repository. These packages will\nbe signed automatically if their creator property matches the name associated\nwith the local repository.

\n\n

Once a package is added to the local repository, any repository that points to\nthis repository as a remote repository will be able to download the package.

\n\n

The sencha package build process generates an appropriate \".pkg\" file in the\nworkspace.build.dir.

\n\n

Syntax

\n\n
sencha package add pkgFile\n
\n\n

Where:

\n\n\n\n\n

sencha package build

\n\n

This command invokes the build process for the current package. Similar to an\napplication and sencha app build, this command builds the current package (as\ndefined by the current folder).

\n\n
sencha package build\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha package build [options] \n
\n\n

sencha package extract

\n\n

This command extracts a package or packages from the repository. If necessary\nthe packages will be downloaded from remote repositories and cached locally for\nfuture use.

\n\n

NOTE: This is not typically executed manually but is handle automatically\nas part of the build process based on the \"requires\" found in \"app.json\" and/or\n\"package.json\".

\n\n

To extract a package named \"foo\" at version \"1.2\" to a specified location:

\n\n
sencha package extract -todir=/some/path foo@1.2\n
\n\n

This will create \"/some/path/foo\". To recursively extract packages required\nby \"foo\", you would do this:

\n\n
sencha package extract -recurse -todir=/some/path foo@1.2\n
\n\n

When complete, \"foo\" and all of its required packages will reside in the folder\nspecified.

\n\n

NOTE: It is recommended to use -todir and allow the package name to be used\nas the immediate subdirectory of that folder. The -outdir option allows you to\nstrip off this directory but prevents recursive extraction as a result.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha package extract [options] packages...\n
\n\n

Where:

\n\n\n\n\n

sencha package get

\n\n

This command ensures that a specified package is locally available. This does\nnot extract the package to a particular location, but rather, enables apps or\nother packages to get the package from the local repository (that is, without\ndownloading it).

\n\n

For example, to ensure that \"foo\" and \"bar\" are available locally:

\n\n
sencha package get foo bar\n
\n\n

To get all packages required by those specified packages:

\n\n
sencha package get -recursive foo bar\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha package get [options] packages...\n
\n\n

Where:

\n\n\n\n\n

sencha package list

\n\n

This command lists packages in the repository. To list available packages\nsimply execute:

\n\n
sencha package list\n
\n\n

To list locally available packages (no download required), do this:

\n\n
sencha package list .\n
\n\n

Otherwise, you can specify the names of package repositories to list:

\n\n
sencha package list sencha\n
\n\n

The above will list the contents of the Sencha Cmd Package Repository.

\n\n

Syntax

\n\n
sencha package list names...\n
\n\n

Where:

\n\n\n\n\n

sencha package remove

\n\n

Removes one or more packages from the local repository.

\n\n

Removes version 1.2 of the package \"foo\":

\n\n
sencha package remove foo@1.2\n
\n\n

Remove all versions of \"foo\"

\n\n
sencha package remove foo@...\n
\n\n

Syntax

\n\n
sencha package remove packageNames...\n
\n\n

Where:

\n\n\n\n\n

sencha package repository

\n\n

These commands manage the local repository and its connections to remote\nrepositories.

\n\n

Remote Repositories

\n\n

The primary role of the local repository is as a cache of packages that it\ndownloads from one or more specified remote repositories. By default, Sencha\nCmd adds the Sencha package repository as a remote repository. Using these\ncommands you can manage these connections.

\n\n

This command adds a remote repository connection named \"foo\":

\n\n
sencha repo add foo http://coolstuff.foo/packages\n
\n\n

Following this command, any packages contained in this repository will be\navailable. Typically these packages are used by adding their name (and possibly\nversion) to your application's \"app.json\" in its requires array.

\n\n
{\n    requires: [\n        'cool-package@2.1'\n    ]\n}\n
\n\n

Then:

\n\n
sencha app build\n
\n\n

The above addition will require version 2.1 of \"cool-package\". The remote\nrepository added above will be checked for this package, and if found, it is\ndownloaded to the local repository and cached there as well as extracted to\nyour app's\"packages/cool-package\" folder and automatically integrated in to\nyour build.

\n\n

Authoring Packages

\n\n

To author packages for others to use in their applications, you will need to\ninitialize your local repository with your name:

\n\n
sencha repo init -name \"My Company, Inc.\"\n
\n\n

See these for more details:

\n\n
sencha help package\nsencha help repo init\n
\n\n

Commands

\n\n\n\n\n

sencha package repository add

\n\n

Adds a remote repository connection. Once added, packages from that repository\nwill be available to applications for use.

\n\n
sencha repo add foo http://foo.bar/pkgs\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha package repository add [options] name \\\n                                        address\n
\n\n

sencha package repository init

\n\n

Initializes the local repository. The local repository is used to cache local\ncopies of packages (potentially for multiple versions).

\n\n

NOTE: This step is not typically necessary because the local repository is\nautomatically initialized in \"anonymous\" mode. This command is needed only if\nyou want to publish packages for others to use in their application. To publish\npackages you must initial the local repository and provide a name:

\n\n
sencha repository init -name \"My Company, Inc.\" -email me@foo.com\n
\n\n

Beyond initializing the repository file structures, this command also generates\na public/private key pair and stores these in the local repository. The private\nkey is used to sign packages added to this local repository.

\n\n

For details on adding packages:

\n\n
sencha help package add\n
\n\n

Private Key

\n\n

Packages added to the local repository with a creator property equal to the\nname given to sencha repository init will be signed using the private key\nstored in the local repository.

\n\n

In this release of Sencha Cmd, these signatures are only used to test package\nintegrity. You can backup this key if desired, but a new key can be regenerated\nby running sencha repo init at any time. In future versions it may be more\nimportant to backup your private key.

\n\n

Remote Access

\n\n

Making the local package repository available as a remote repository for others\nto access requires some knowledge of the disk structure of the repository. By\ndefault, Sencha Cmd creates the local repository adjacent to its installation\nfolder. For example, given the following location of Sencha Cmd:

\n\n
/Users/myself/bin/Sencha/Cmd/3.1.0.200/\n
\n\n

The local respository is located at:

\n\n
/Users/myself/bin/Sencha/Cmd/repo\n
\n\n

This is to allow your local repository to be used by newer versions of Sencha\nCmd. The folder to publish to others as an HTTP URL is:

\n\n
/Users/myself/bin/Sencha/Cmd/repo/pkgs\n
\n\n

IMPORTANT: Do NOT expose the parent folder of \"pkgs\" - that folder holds\nprivate information (such as your private key). Further, Sencha Cmd will not\nrecognize the structure as a valid remote repository.

\n\n

If you want to host the repository on a public server, simply copy the \"pkgs\"\nfolder to a web server and share the HTTP address.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha package repository init [options] \n
\n\n

sencha package repository list

\n\n

Lists all remote repository connections.

\n\n

Syntax

\n\n
sencha package repository list \n
\n\n

sencha package repository remove

\n\n

Remove a remote repository from the local repository's list of remote\nrepositories. For example, if a remote was previously added:

\n\n
sencha repo add foo http://foo.bar/pkgs\n
\n\n

This command will remove it:

\n\n
sencha repo remove foo\n
\n\n

NOTE: This command does not remove packages that you may have downloaded from\nthis remote as they are now cached in the local repository.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha package repository remove [options] name\n
\n\n

sencha package repository show

\n\n

Shows information about a remote repository.

\n\n

To show information about the local repository:

\n\n
sencha repo show .\n
\n\n

To show information about a specific remote repository:

\n\n
sencha repo show some-remote\n
\n\n

The name given should match the name previously given to:

\n\n
sencha repo add some-remote ...\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha package repository show [options] names...\n
\n\n

Where:

\n\n\n\n\n

sencha package repository sync

\n\n

Forces (re)synchronization with a remote repository catalog. Normally this is\ndone periodically and does not need to be manually synchronized. This command\nmay be needed if there something known to have been added to a remote repo but\nhas not yet shown up in the catalog on this machine.

\n\n
sencha repo sync someremote\n
\n\n

To resynchronize with all remote repositories:

\n\n
sencha repo sync\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha package repository sync [options] [name]\n
\n\n

sencha package upgrade

\n\n

Upgrades the current package to a newer SDK or Sencha Cmd version.

\n\n

This command must be run from the desired package's folder.

\n\n

Syntax

\n\n
sencha package upgrade \n
\n\n

sencha repository

\n\n

These commands manage the local repository and its connections to remote\nrepositories.

\n\n

Remote Repositories

\n\n

The primary role of the local repository is as a cache of packages that it\ndownloads from one or more specified remote repositories. By default, Sencha\nCmd adds the Sencha package repository as a remote repository. Using these\ncommands you can manage these connections.

\n\n

This command adds a remote repository connection named \"foo\":

\n\n
sencha repo add foo http://coolstuff.foo/packages\n
\n\n

Following this command, any packages contained in this repository will be\navailable. Typically these packages are used by adding their name (and possibly\nversion) to your application's \"app.json\" in its requires array.

\n\n
{\n    requires: [\n        'cool-package@2.1'\n    ]\n}\n
\n\n

Then:

\n\n
sencha app build\n
\n\n

The above addition will require version 2.1 of \"cool-package\". The remote\nrepository added above will be checked for this package, and if found, it is\ndownloaded to the local repository and cached there as well as extracted to\nyour app's\"packages/cool-package\" folder and automatically integrated in to\nyour build.

\n\n

Authoring Packages

\n\n

To author packages for others to use in their applications, you will need to\ninitialize your local repository with your name:

\n\n
sencha repo init -name \"My Company, Inc.\"\n
\n\n

See these for more details:

\n\n
sencha help package\nsencha help repo init\n
\n\n

Commands

\n\n\n\n\n

sencha repository add

\n\n

Adds a remote repository connection. Once added, packages from that repository\nwill be available to applications for use.

\n\n
sencha repo add foo http://foo.bar/pkgs\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha repository add [options] name \\\n                                address\n
\n\n

sencha repository init

\n\n

Initializes the local repository. The local repository is used to cache local\ncopies of packages (potentially for multiple versions).

\n\n

NOTE: This step is not typically necessary because the local repository is\nautomatically initialized in \"anonymous\" mode. This command is needed only if\nyou want to publish packages for others to use in their application. To publish\npackages you must initial the local repository and provide a name:

\n\n
sencha repository init -name \"My Company, Inc.\" -email me@foo.com\n
\n\n

Beyond initializing the repository file structures, this command also generates\na public/private key pair and stores these in the local repository. The private\nkey is used to sign packages added to this local repository.

\n\n

For details on adding packages:

\n\n
sencha help package add\n
\n\n

Private Key

\n\n

Packages added to the local repository with a creator property equal to the\nname given to sencha repository init will be signed using the private key\nstored in the local repository.

\n\n

In this release of Sencha Cmd, these signatures are only used to test package\nintegrity. You can backup this key if desired, but a new key can be regenerated\nby running sencha repo init at any time. In future versions it may be more\nimportant to backup your private key.

\n\n

Remote Access

\n\n

Making the local package repository available as a remote repository for others\nto access requires some knowledge of the disk structure of the repository. By\ndefault, Sencha Cmd creates the local repository adjacent to its installation\nfolder. For example, given the following location of Sencha Cmd:

\n\n
/Users/myself/bin/Sencha/Cmd/3.1.0.200/\n
\n\n

The local respository is located at:

\n\n
/Users/myself/bin/Sencha/Cmd/repo\n
\n\n

This is to allow your local repository to be used by newer versions of Sencha\nCmd. The folder to publish to others as an HTTP URL is:

\n\n
/Users/myself/bin/Sencha/Cmd/repo/pkgs\n
\n\n

IMPORTANT: Do NOT expose the parent folder of \"pkgs\" - that folder holds\nprivate information (such as your private key). Further, Sencha Cmd will not\nrecognize the structure as a valid remote repository.

\n\n

If you want to host the repository on a public server, simply copy the \"pkgs\"\nfolder to a web server and share the HTTP address.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha repository init [options] \n
\n\n

sencha repository list

\n\n

Lists all remote repository connections.

\n\n

Syntax

\n\n
sencha repository list \n
\n\n

sencha repository remove

\n\n

Remove a remote repository from the local repository's list of remote\nrepositories. For example, if a remote was previously added:

\n\n
sencha repo add foo http://foo.bar/pkgs\n
\n\n

This command will remove it:

\n\n
sencha repo remove foo\n
\n\n

NOTE: This command does not remove packages that you may have downloaded from\nthis remote as they are now cached in the local repository.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha repository remove [options] name\n
\n\n

sencha repository show

\n\n

Shows information about a remote repository.

\n\n

To show information about the local repository:

\n\n
sencha repo show .\n
\n\n

To show information about a specific remote repository:

\n\n
sencha repo show some-remote\n
\n\n

The name given should match the name previously given to:

\n\n
sencha repo add some-remote ...\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha repository show [options] names...\n
\n\n

Where:

\n\n\n\n\n

sencha repository sync

\n\n

Forces (re)synchronization with a remote repository catalog. Normally this is\ndone periodically and does not need to be manually synchronized. This command\nmay be needed if there something known to have been added to a remote repo but\nhas not yet shown up in the catalog on this machine.

\n\n
sencha repo sync someremote\n
\n\n

To resynchronize with all remote repositories:

\n\n
sencha repo sync\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha repository sync [options] [name]\n
\n\n

sencha theme

\n\n

This category contains low-level commands for managing themes. Typically these\noperations are handled by sencha app build and/or sencha package build.

\n\n

Commands

\n\n\n\n\n

sencha theme build

\n\n

This command will build the specified theme's image sprites.

\n\n

IMPORTANT: This command should only be used for Ext JS 4.1 applications. For\nExt JS 4.2 applications, themes are now packages and should be managed using\nthe sencha package build process.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha theme build [options] [theme-name] \\\n                             [environment]\n
\n\n

sencha theme capture

\n\n

This command will capture an image and slice manifest for a specified page.

\n\n

It is rarely necessary to call this command directly as it is part of the theme\nbuild process. In Ext JS 4.2 applications or theme packages, this command is\ncalled by the build script's slice step. In Ext JS 4.1 applications this is\ncalled for each application theme or directly by the 'sencha theme build`\ncommand.

\n\n

For example, this is roughly the command performed by the slice step for a\ntheme package:

\n\n
sencha theme capture -page sass/example/theme.html \\\n                     -image build/theme-capture.png \\\n                     -manifest build/theme-capture.json\n
\n\n

Once the image and slicer manifest are produced, the sencha fs slice command\nextracts the background images and sprites required for Internet Explorer.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha theme capture [options] \n
\n\n

sencha theme slice

\n\n

This command performs image slicing and manipulation driven by the contents of\na JSON manifest file. The manifest file contains an array of image area\ndefinitions that further contain a set of \"slices\" to make.

\n\n

This file and the corresponding image are typically produced for a Theme as\npart of the theme package build. For details on this process, consult this\nguide:

\n\n

http://docs.sencha.com/ext-js/4-2/#!/guide/command_slice

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha theme slice [options] \n
\n\n

sencha upgrade

\n\n

This command downloads and installs the current version of Sencha Cmd. Or you\ncan specify the version you want to install as part of the command.

\n\n

The following command downloads and installs the current version of Sencha Cmd:

\n\n
sencha upgrade\n
\n\n

This command downloads a particular version:

\n\n
sencha upgrade 3.0.2.288\n
\n\n

If the version requested is the already installed then this command will, by\ndefault, do nothing. This can be forced using --force:

\n\n
sencha upgrade --force\n
\n\n

If the version requested is the version in the PATH, the command will exit\nwith a message saying that the current version cannot be upgraded. In this case\nthe --force option is ignored.

\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha upgrade [options] [version=\"\"]\n
\n\n

sencha which

\n\n

This command display the location of Sencha Cmd.

\n\n
sencha which\nC:\\Users\\Me\\bin\\Sencha\\Cmd\\3.1.0.220\n
\n\n

Options

\n\n\n\n\n

Syntax

\n\n
sencha which [options] \n
\n"});