The OpenFin Command Line Interface (CLI) tool is a Node package used launch any existing web application (or web page) on OpenFin from the command line. If you do not already have an application configuration file, the CLI tool can create a local file with using default settings for the minimum required values.
More information about the Application Configuration file can be found on our Application config page.
Detailed information about the OpenFin CLI tool can be found on the OpenFin-CLI GitHub repository.
Installing the OpenFin CLI
From a terminal console, type:
npm install -g openfin-cli
Launching using an application using a URL
The -l (or --launch) and -u (or --url) parameter combination is used to launch an application on OpenFin using the application URL.
openfin -l -u https://apple.com
Once executed, the CLI will create a local app.json file with default settings for the minimum required values, in the location the CLI was called from. Once this file has been created it can be used for subsequent application launches, using the CLI tool with the -c parameter (see below). The local file can be edited, more information about the options available in the Application Configuration file can be found on our Application config page.
Launching using an Application Configuration
The -l (or --launch) and -c (or --config) parameter can be used with the CLI tool to launch an application using an OpenFin Application configuration file:
openfin -l -c <url of manifest>
If you are running the CLI tool from a folder where an app.json file is located, only the -l parameter is required: