CLI
Categories:
Arguments
Arguments must be entered before commands.
-c [path]
Path to the JSON/Jsonnet configuration file.
-f [format]
Set log format (human, kv, raw, default: human).
-l [level]
Set minimum log level (none, debug, info, error, default: info).
-p
Disable paging via less.
-s [status]
Set the minimum status for error message logging.
-x [key=value]
Set config key=value (can be provided multiple times).
Commands
Homechart comes with a list of default Commands, but you can add custom Commands using Macros–Command templates that live within the Homechart configuration.
Commands also support partial matching. Homechart will attempt to match a partial CLI command (like cfg) to the longest matching command or macro (in this instance, config).
autocomplete
Adds autocomplete for Homechart commands into your terminal:
$ source <(homechart autocomplete)
config
Show the rendered config from all sources (file, environment variables, and command line arguments).
docs
Open a web browser to the documentation website (this website).
eula
View the Homechart End User License Agreement (EULA).
generate-vapid
Generate a private and public key for use with Web Push. See Config > webPush for more information.
run
Run Homechart server.
seed [output path]
Seed the database with mock data and save the output to as JSON to the output path.
show-config
Print the current configuration as JSON or YAML.
tasks-*
Manually run background maintenance tasks.
version
Print the current version of Homechart.