strapkit/doc/help.txt

Write once, deploy everyWear. Cross platform development tools for wearables.

Synopsis

    strapkit command [options]

Global Commands

    create <PATH> [ID [NAME [CONFIG]]] ....... creates a new StrapKit project in the specified PATH, with
                                               ID reverse-domain-style package name - used in <widget id>
                                               NAME is a human readable field
                                               CONFIG is a json string whose key/values will be included
                                               in [PATH]/.strap/config.json
                  [--copy-from|src=<PATH>] ... use custom js assets instead of the stock StrapKit hello-world.
                  [--link-to=<PATH>] ......... symlink to custom js assets without creating a copy.

    help ..................................... shows this syntax summary


Project-Level Commands

    platform(s) [{add|remove|rm} <PLATFORM>] .. add or remove a specified PLATFORM, OR
                [{list|ls}] ................... list all installed and available platforms
                [{update|up} <PLATFORM>] ...... update the version of StrapKit used for a specific
                                                PLATFORM; use after updating the CLI.
                [check] ....................... list platforms which can be updated by `platform update`

    prepare [PLATFORM..] ...................... copies files for specified platforms, or all platforms,
                                                so that the project is ready to build in each SDK

    compile [PLATFORM..] ...................... builds the app for specified platforms, or all platforms

    build [PLATFORM...] ....................... shortcut for prepare, then compile

    run [--debug|--release]
        [--device|--emulator|--target=FOO]
        [PLATFORM] ............................ deploys app on specified platform devices / emulators

    emulate [PLATFORM...] ..................... alias for "run --emulator"

Command-line Flags/Options

    -v, --version ............................. prints out this utility's version
    -d, --verbose ............................. debug mode produces verbose log output for all activity,
                                                including output of sub-commands StrapKit invokes

Example usage

    Basic Format of strapkit create
    $ strapkit create <path_to_new_project> <package_name> <project_name> [config.xml]

    $ strapkit create ~/Desktop/TestProject com.straphq.testproject TestProject ./configFile.xml
    OR
    $ strapkit create TestProject

    $ cd TestProject
    $ strapkit platform add pebble
    $ strapkit build
    $ strapkit install pebble