pcable / openfin-cli

Launch the OpenFin runtime

OpenFin Runtime cli tool

The OpenFin Cli tool will allow you to launch the OpenFin runtime given a url or a configuration file, it will also allow you to create configuration files by giving only name and url.

Dependencies

You will need Node.js to use the tool and creating configs will work cross platform, but launching the OpenFin runtime is restricted to Windows at the moment.

Install

$ npm install -g openfin-cli

Usage

$ openfin --help

Examples

Launching OpenFin Demos

$ openfin --launch --config http://cdn.openfin.co/demos/hyperblotter/app.json
$ openfin --launch --config https://demoappdirectory.openf.in/desktop/config/apps/OpenFin/HelloOpenFin/app.json

Launching an application

$ openfin --launch --url http://www.openfin.co

Shorthand

$ openfin -l -u http://www.openfin.co

Creating a config file

$ openfin --config myconfig.json --name myAppName --url http://www.openfin.co

Shorthand

$ openfin  -c myconfig.json -n myAppName -u http://www.openfin.co

Launching a given config file

$ openfin --launch --config myconfig.json
$ openfin --launch --config http://goo.gl/w2747v

Shorthand

$ openfin -l -c myconfig.json
$ openfin -l -c http://goo.gl/w2747v

Generate installer URL

Will print a url to the console with the name proivided via the -n flag and the hosted confg file url provided via the -c flag

$ openfin -n OpenFinPOC -c http://goo.gl/w2747v -h

Download an installer zip locally

Use the -d or --destination flag to specify the directory of the download. To download to the current directory use -d . or --destination .

$ openfin --destination my-dist-directory --installer http://goo.gl/w2747v

Shorthand

$ openfin -d my-dist-directory -i http://goo.gl/w2747v

Installer config options

--no-ext If set “true”, the file is extention-less'
--rvm-config URL that points to the RVM config. Must be a full URL.'
'--support-email The email address to display in the installer when an error occurs. Default value = [e-mail]"'
--dnl Installs an application without launching it. Set value to true [dnl=true]'

License

Apache 2.0

The code in this repository is covered by the included license.

However, if you run this code, it may call on the OpenFin RVM or OpenFin Runtime, which are covered by OpenFin’s Developer, Community, and Enterprise licenses. You can learn more about OpenFin licensing at the links listed below or just email us at [e-mail] with questions.

https://openfin.co/developer-agreement/
https://openfin.co/licensing/