appworks

appworks-cli

Command line tools for OpenText AppWorks

• Usage
• Commands

Usage

$ npm install -g appworks
$ appworks COMMAND
running command...
$ appworks (-v|--version|version)
appworks/1.0.0 darwin-x64 node-v8.11.3
$ appworks --help [COMMAND]
USAGE
  $ appworks COMMAND
...

Commands

• appworks help [COMMAND]
• appworks package
• appworks start [REPO]

appworks help [COMMAND]

display help for appworks

USAGE
  $ appworks help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

appworks package

Package the app in the current directory to be deployed on the AppWorks Gateway

USAGE
  $ appworks package

OPTIONS
  -f, --force
  -h, --help       show CLI help

  -i, --from=from  the directory to package for deployment - this directory contains your application's final
                   javascript, html, css, images, and any other assets. default is "www"

  -o, --to=to      the directory to store the packaged bundle. default is "package"

EXAMPLES
  $ appworks package
  (packages the 'www' directory for deployment)

  $ appworks package --from build --to dist
  (packages the 'build' directory for deployment)

See code: src/commands/package.ts

appworks start [REPO]

Create a new appworks app from a template. Defaults to starter

USAGE
  $ appworks start [REPO]

OPTIONS
  -a, --awgPlatformVersion=awgPlatformVersion  AppWorks Gateway platform version of your project
  -d, --description=description                description of your project
  -h, --help                                   show CLI help
  -n, --name=name                              name of your new project
  -r, --release=release                        release number of your project
  -t, --template=template                      git repository to clone
  -v, --version=version                        version number of your project

EXAMPLES
  $ appworks start --name MyApp
  Cloning repo https://github.com/opentext/appworks-app-starter into MyApp

  $ appworks start --name MyApp --template https://github.com/opentext/appworks-js-example-camera
  cloning repo https://github.com/opentext/appworks-js-example-camera into MyApp

See code: src/commands/start.ts