CLI
help
Show help for a commmand
Arguments
COMMAND
Command name
Type: command
init
Create and initialize config file.
Options
--config-file, -c
<CONFIG_FILE>
Location of the config file.
Type: path
--overwrite
Overwrite existing config
Type: boolean
Default: False
--url, -u
<URL>
Zabbix API URL to use.
Type: text
login
Reauthenticate with the Zabbix API.
Creates a new auth token file if enabled in the config.
Options
--username, -u
<USERNAME>
Username to log in with.
Type: text
--password, -p
<PASSWORD>
Password to log in with.
Type: text
--token, -t
<TOKEN>
API token to log in with.
Type: text
migrate_config
Migrate a legacy .conf config to a new .toml config.
The new config file will be created in the default location if no destination is specified. The new config enables the new JSON format by default.
Options
--source, -s
<SOURCE>
Location of the config file to migrate.
Type: path
--destination, -d
<DESTINATION>
Path of the new config file to create. Uses the default config path if not specified.
Type: path
--overwrite
Overwrite destination config file if it exists.
Type: boolean
Default: False
--legacy-json-format
Use legacy JSON format mode in the new config file.
Type: boolean
Default: False
open
Open an app directory in the system's file manager.
Use --force to attempt to open when no DISPLAY env var is set.
Arguments
DIRECTORY_TYPE
The type of directory to open.
Type: choice
Choices: config, data, logs, siteconfig, exports
Required: ✅
Options
--force
LINUX: Try to open with --command even if no window manager is detected.
Type: boolean
Default: False
--path
Show path instead of opening directory.
Type: boolean
Default: False
--command
<OPEN_COMMAND>
Specify command to use to use for opening.
Type: text
sample_config
Print a sample configuration file.
show_config
Show the current application configuration.
Options
--secrets
<SECRETS>
Display mode for secrets.
Type: choice
Choices: hide, masked, plain
Default: masked
show_dirs
Show the default directories used by the application.
show_history
Show the command history.
Options
--limit, -n
<LIMIT>
Limit the number of results. 0 to show all.
Type: integer
Default: 0
update_config
Write the current configuration to the config file.
Useful if you authenticate with a new user or change the URL, and want to save the changes to the config file. Furthermore, this helps to migrate an outdated config file to the newest version.
Options
--config-file, -c
<CONFIG_FILE>
Location of the config file to update.
Type: path
--secrets
<SECRETS>
Visibility mode for secrets.
Type: choice
Choices: hide, masked, plain
Default: plain
--force
Skip confirmation prompt.
Type: boolean
Default: False