ORB Creator – Command line interface

ORB Creator supports a powerful command-line interface.

This can be used for scripting or automating the creation of ORB packages.

Command

To use the CLI interface just type:

orb-creator -i <folder_path> <arguments>

Arguments

-i, --input-folder <path>

Set the folder to the packaged

Example: orb-creator -i /tmp/app

 

-o, --output-full-path <path>

Sets the full path of the final file

 

--enable-squashfs-compression

Enable squashfs compression, thus creating app.squashfs (enabled by default)

 

--disable-squashfs-compression

Disable squashfs compression, thus packaging the contents of the input folder directly into the ISO

It is useful for small programs (which would not really benefit very much from compression)

 

--app-full-name <NAME OF YOU APP>

Sets the “Full name” for the Application inside the container.

Example: orb-creator -i /tmp/app --app-full-name "Mozilla Firefox"

 

--app-version <VERSION>

Sets the “version” for the Application inside the container.

Example: orb-creator -i /tmp/app --app-full-name --app-version "2.7"

 

--iso-label

Set the name/label (volume ID) for the ISO.
Make sure to use quotes if the label has spaces.

This “ISO Label” only appears when manually mounting the .orb file as an .iso, which should normally not happen.

Example: orb-creator -i /tmp/app --iso-label "Mozilla Firefox"

 

--amd64-launcher

(This is enabled by default)

This sets the embedded launcher to an AMD64 ELF executable.

This makes the .orb file appear as an AMD64 (64 bits) ELF executable on systems without ORB Launcher.

This allows the .orb file to be executed like any Linux program on a AMD64 (64 bits) computer.

Example: orb-creator -i /tmp/app --amd64-launcher

 

--i386-launcher

This sets the embedded launcher to an i386 ELF executable.

This makes the .orb file appear as an i386 (x86 / 32 bits) ELF executable on systems without ORB Launcher.

This allows the .orb file to be executed like any Linux program on a i386 (x86 / 32 bits) computer

Example: orb-creator -i /tmp/app --i386-launcher

 

-h, --help--usage

Shows the help and the way to use the arguments

Example: orb-creator --help

Examples

orb-creator -i /home/david/firefox_portable --iso-label "Firefox Portable"
orb-creator --input-folder /home/david/firefox_portable --output-full-path /media/USB/firefox.orb
orb-creator --disable-squashfs-compression -i /home/david/firefox_portable --o /media/USB/firefox.orb