Command line interface (CLI)
Bifröst is usually available via its bifroest command on each operating system.
Running the server
Syntax: bifroest run [flags]
Flags
Includes all general flags.
--configuration
-cFile Path<Configuration> = "<os specific>"
The default value varies depending on the platform Bifröst runs on:
- Linux:
/etc/engity/bifroest/configuration.yaml - Windows:
C:\ProgramData\Engity\Bifroest\configuration.yaml
Show version
Syntax: bifroest verion [flags]
Flags
Includes all general flags.
Service management
Note
Only available on Windows.
Installation
Installation of Bifröst as service inside the operating system, which will let it run upon system start and with full privileges.
Syntax: bifroest service install [flags]
Flags
Includes all general flags.
--name
string = "engity-bifroest"
Name of the service.
--configuration
-cFile Path<Configuration> =
"C:\\ProgramData\\Engity\\Bifroest\\configuration.yaml"
Configuration location to use for the installed service.
--start
bool = true
If installed, should it be started immediately. This calls implicitly bifroest service start.
Removal
Will remove an installed service instance of Bifröst from the operating system.
Syntax: bifroest service remove [flags]
Flags
Includes all general flags.
--name
string = "engity-bifroest"
Name of the service.
--stop
bool = true
Same as calling bifroest service stop before this command.
Start
Will start the installed service instance of Bifröst.
Syntax: bifroest service start [flags]
Flags
Includes all general flags.
--name
string = "engity-bifroest"
Name of the service.
Stop
Will stop the installed service instance of Bifröst (if running).
Syntax: bifroest service stop [flags]
Flags
Includes all general flags.
--name
string = "engity-bifroest"
Name of the service.
General
Flags
--log.level
Log Level = "INFO"
Defines the minimum level at which the log messages will be logged.
--log.format
Log Format = "text"
In which format the log output should be printed.
--log.colorMode
Log Color Mode = "auto"
Tells whether to log in color or not.
--version
Same as using sub-command version.