Engine Commands
insider 2026-10-02 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 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 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 completion
Generate the autocompletion script for niksphere-engine for the specified shell. See each sub-command's help for details on how to use the generated script.
Every generated script is tied to the literal command name "niksphere-engine" - it does not adapt to whatever file name your binary happens to have. There is currently no installer that places the Engine on PATH under that exact name, so if you're running a manually downloaded, version- and architecture-suffixed binary directly, create an alias first so your shell resolves "niksphere-engine" to it (replace <your-niksphere-engine-binary> below with the actual downloaded file name), e.g. in PowerShell:
Set-Alias niksphere-engine .\<your-niksphere-engine-binary>.exe
or in bash/zsh:
alias niksphere-engine=./<your-niksphere-engine-binary>
niksphere-engine self completion [bash|zsh|fish|powershell]Arguments:
| Argument | Required | Description |
|---|---|---|
| `bash | zsh | fish |
niksphere-engine self completion bash
Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package. If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
source <(niksphere-engine self completion bash)
To load completions for every new session, execute once:
Linux:
niksphere-engine self completion bash > /etc/bash_completion.d/niksphere-engine
macOS:
niksphere-engine self completion bash > $(brew --prefix)/etc/bash_completion.d/niksphere-engine
You will need to start a new shell for this setup to take effect.
niksphere-engine self completion bash [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--no-descriptions | (None) | (None) | disable completion descriptions |
niksphere-engine self completion fish
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
niksphere-engine self completion fish | source
To load completions for every new session, execute once:
niksphere-engine self completion fish > ~/.config/fish/completions/niksphere-engine.fish
You will need to start a new shell for this setup to take effect.
niksphere-engine self completion fish [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--no-descriptions | (None) | (None) | disable completion descriptions |
niksphere-engine self completion powershell
Generate the autocompletion script for powershell.
To load completions in your current shell session:
niksphere-engine self completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command to your PowerShell profile ($PROFILE).
niksphere-engine self completion powershell [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--no-descriptions | (None) | (None) | disable completion descriptions |
niksphere-engine self completion zsh
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(niksphere-engine self completion zsh)
To load completions for every new session, execute once:
Linux:
niksphere-engine self completion zsh > "${fpath[1]}/_niksphere-engine"
macOS:
niksphere-engine self completion zsh > $(brew --prefix)/share/zsh/site-functions/_niksphere-engine
You will need to start a new shell for this setup to take effect.
niksphere-engine self completion zsh [flags]Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--no-descriptions | (None) | (None) | disable completion descriptions |
niksphere-engine service
Manage the Niksphere Engine background service lifecycle (install, uninstall, start, stop, restart) on Windows, Linux, and macOS.
For more information and detailed guides, see: https://go.niksphere.de/cli-engine-service-help
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