Note: This documentation is for wq 1.2, which has not yet been finalized.
wq is a configuration-based command-line tool that can be used to compile application code into a compact offline-capable format. It is included in wq.core and should be available from the command line after installing wq or wq.app.
wq.app provides a number of
wq commands for creating and optimizing offline-capable web apps, the most notable of which is the
wq build command. The main usage of
wq build is as follows:
wq -c [configfile] build [version]
[version]is the version of the application being built
[configfile]is the path to a configuration file to use (the default is to look for a file named
wq.ymlin the current directory). The django-wq-template project contains an example wq.yml.
The actual build process is broken into several steps. Each step is typically configured via a corresponding key in the wq.yml configuration file, though most accept the same options as command-line arguments. You can get more information about the options for each command via
wq --help, for example:
wq init --help
|init||Prepares the project for build by adding symbolic links from the project folder to the wq assets.|
||loads the application version from a version.txt file (or from the command line) and creates a simple AMD module (typically called
|scss||compiles SCSS into regular CSS, useful for creating custom jQuery Mobile themes.|
|mustache||compile a Mustache template and context into a static HTML page.|
||Creates HTML5 application cache manifests for both the source and compiled applications by examining the logs from build process.|
||runs all of the above in order.|