Skip to content

CLI

Root command

Terminal window
Manage the chorescore application stack
Usage:
chorescore [command]
Available Commands:
api Start only the API endpoints
api-docs Information about the docs
completion Generate the autocompletion script for the specified shell
config Write config
help Help about any command
project-docs Start the project documentation
redis Run Redis commands
server Starts the server
ui Start the ui routes
Flags:
-h, --help help for chorescore
-l, --log-level string Set the log level. Environment file (LOG-LEVEL)
(-1...5)
(trace...fatal)
(TRACE...FATAL) (default "3")
Use "chorescore [command] --help" for more information about a command.

Subcommand server

Terminal window
Start the server.
The first and only argument is a feature comma seperatured list.
Bundles of features can be selected via flags.
Usage:
chorescore server [features] [flags]
Examples:
chorescore server -a All stable features.
chorescore server -a -n All stable and experimental features.
chorescore server -a -s All standard features and certificates directly provided
to the container via environment variables.
chorescore server -a -r All standard features and certificates provided via cert-manager.
chorescore server -a -n -d -e -u -l -1 Recommented development configuration
chorescore server -a -m Distribution of the UIs over multiple ports.
Flags:
-a, --all-standard-features Enable all features
-b, --basic-auth Require basic authorization for cookie request
-c, --config string Set the cli config file (default ".chorescore.yaml")
-d, --development This changes the allowed origin headers and exposes Redis queries
-u, --disable-auth Disable authentication on the server
-n, --experimental-features Enable experimental features, via nightly
-e, --export Should only be used in development, adds insecure backup routes
-h, --help help for server
-m, --multi-port Distributions for multi port setup: 3000:ui,3001:api,3002:api-docs,3003:docs
-r, --registry-certs Enable autotls via CertManager by TLS. Requires mapping of port 443 and 80
-s, --tls Enable TLS
Global Flags:
-l, --log-level string Set the log level. Environment file (LOG-LEVEL)
(-1...5)
(trace...fatal)
(TRACE...FATAL) (default "3"