Engine Commands
insider 2026-08-26 JSON ↗Global Options
The following flags can be passed to any command:
| Flag | Short | Type | Description |
|---|---|---|---|
--json | -j | boolean | Output results in JSON format |
Commands Overview
| Command | Description |
|---|---|
niksphere-engine help | Help about any command |
niksphere-engine run | Start the Niksphere Engine server |
niksphere-engine self | Manage the Niksphere Engine itself |
niksphere-engine service | Manage Niksphere Engine as an OS service |
niksphere-engine help
Help provides help for any command in the application. Simply type niksphere-engine help [path to command] for full details.
niksphere-engine helpniksphere-engine run
Start the Niksphere Engine HTTP and API server in interactive or background service mode.
niksphere-engine run [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--config | -c | (None) | Path to configuration file |
--service-name | (None) | niksphere-engine | Name of the service (used under SCM) |
niksphere-engine self
Manage components, view information, and export metadata for the Niksphere Engine itself.
niksphere-engine selfniksphere-engine self about
Print information about Niksphere Engine
niksphere-engine self aboutniksphere-engine self usage
Export the full Niksphere Engine CLI command hierarchy, options, and flags as a standardized Usage JSON specification.
niksphere-engine self usage [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--format | -f | json | Output format ('json' or 'kdl') |
--out | -o | (None) | File path to save the generated usage specification |
niksphere-engine service
Manage the Niksphere Engine background service lifecycle (install, uninstall, start, stop, restart) on Windows, Linux, and macOS.
niksphere-engine service [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--config | -c | (None) | Path to configuration file |
--service-name | (None) | niksphere-engine | Name of the service (used under SCM) |
niksphere-engine service install
Install the engine as an OS service
niksphere-engine service installniksphere-engine service restart
Restart the OS service
niksphere-engine service restartniksphere-engine service start
Start the OS service
niksphere-engine service startniksphere-engine service stop
Stop the OS service
niksphere-engine service stopniksphere-engine service uninstall
Uninstall the OS service
niksphere-engine service uninstall