Skip to main content

OrBIT User Guide

The OrBIT command line application

In this section:

OrBIT is a command line application whose primary task is to generate product package (PPKG) files for the Embedded Secure IP system.

System requirements

To use OrBIT, you need:

  • Microsoft Windows 10 or later

  • An Intel® Core™ i5 8th Gen or later processor (minimum—an i7 8th Gen is preferred)

  • A minimum of 4 Gbytes RAM (16 Gbytes RAM is preferred)

Installing OrBIT

  1. Locate the installer and double-click it to start the installation.

  2. For the default installation, select the check box to agree to the license terms and conditions, then click Install. If a dialog box asks you to confirm that you trust the installer, click Yes.

  3. When the installation has finished, click Close.

Invocation syntax

When installed, OrBIT is available globally across the system and the path is added to the System PATH environment variable.

The OrBIT invocation syntax is:

orbit command [options] [arguments]

The order of the command line arguments is not important. Some commands take extra options.

For example, to generate the configuration files with the GetSampleConfig command, specifying a product template to base it on:

orbit GetSampleConfig --productTemplate "Dynamic_Provisioning" --output "C:\OrbitFiles"

The OrBIT parameters are:

Parameter

Description

command

The command to execute. See Commands.

options

Options that can be used together with some commands. See Global options and Command-specific options.

arguments

Arguments given to some options, described in the option description.