Orbit - api-commands

Commands

Find below a list of all of orbits cli commands along with usage examples

The following flags are supported by all build type commands. (build, dev, init & deploy)

--mode a string to override the provided build mode. (development/ production)
--pacname a string to specify the package name for the auto generated code files
--webdira path that specifies the location of the input directory for orbit to bundle
--out a path to write out the auto generated files to
--publicdira path for an html file, that will override the default HTML structure (note: this only overrides the head & body tags)
--nodemoda path that specifies the location of node_modules
--depouta path that specifies the output location of a dependency map
--experimentalcommand delimited string specifying a list of experimental features List of experimental features

The build command bundles the provided pages in production mode.

In addition to the base flags, the build command supports the following:

The deploy command prepares the provided pages for deployment

Notice

This deployment command currently only supports static file generation.

In addition to the base flags, the deploy command supports the following:

--staticouta path that specifies the directory to output the static files to.

The dev command provides the ability to hot reload development code

In addition to the base flags, the dev command supports the following:

--timeoutduration in milliseconds until a change will be detected default: 2000
--samefiletimeoutspecifies the timeout duration in milliseconds until a change will be detected for repeating files default: 2000
--hotreloadportport used for hotreloading default: 3005
--terminateonstartupterminates the process after the startup sequence has been completed (uses for regression testing). default: false

Displays a list of experimental features to be used where --experimental flag is accepted.

You can find a copy of that list here

Creates a template project and installs the required dependencies

In addition to the base flags, the init command supports no other flags.

Below is a list of tools included within orbit, you may use them like so: orbit tool 'tool_name'

No flags are currently supported by the flags command

Visualization tool to display the output of the "--depout" flag.