Instant config describes which packages to make available in the CLI and a set of profiles which allow you to easily operate on a group of packages and apply env var files to configure then.

To generate a config file use the ./instant project generate command.

A single file may be used for configuration

A reference config file looks like this:

• projectName - gives this project configuration a name

• image - defines the Docker image to use during deployment. This image should container the packages you wish to launch if you are not using customPackages. A default image with no packages included can be found at openhie/package-base:latest

• logPath - gives a location to put log of the CLI output, useful for debugging

Launching individual packages

Once a config has been defined with 1 or more packages, you may launch or stop packages by using the .

Launching a profile

If you want to launch all the packages listed in a profile with the specified configuration and env vars applied, use the .

Launching entire projects

Instead of individual packages, you can also launch everything define in your project config by using the .

Changing the default banner displayed in the CLI

The CLI banner refers to the uppermost display when running the CLI. This banner may be overwritten by including a banner.txt file at the root of the project that includes the new banner in ascii format. A tool that may be used to generate this banner may be found

Usage

Main Commands

Sub Commands

package

The package sub command includes commands:

The package level commands, as shown, are there to control packages within a project, as well as generate the skeleton for a new package.

Each of these sub commands accept the following flags:

E.g. ./instant package init -n interoperability-layer-openhim

For information about flags associated to any one of the package commands, do instant-linux package [command] --help

project

The project sub command includes commands:

The project level commands, as shown, are there to simultaneously perform commands on all packages in a project, as well as generate the config file for a new project, in the desired format.

Each of these sub commands accept the following flags:

For information about flags associated to any one of the project commands, do instant-linux project [command] --help

completion

The completion sub command includes commands:

The project level commands, as shown, are there to enable autocomplete for the specified shell.

The following section explain the technical detail on how to get started with Instant OpenHIE and how to configure what you want to get deployed.

Prerequisites:

• Install docker

  • On linux: install the docker package

  • On OSX or Windows:

• Enable swarm mode in docker: docker swarm init

To get started with Instant OpenHIE you will first need to download the CLI tool. The binary may be download via the terminal with the following url based on your operating system

To test that the binary works, run the executable with no commands to see the help text.

Next, you would want to configure which packages Instant can deploy for your particular needs.

Instant doesn't ship with any default packages to deploy. Packages are expected to be created by the community and in time there will be many option available. Jembi has curated a set of packages that we commonly use to help implementer to get started with a foundational set of health information exchange components. To get started with that pre-configured package set, see the .

Otherwise, you may create your own config for your . Continue to config section to find out how.