CLI reference
Control Kodi with Alexa. Run encore <command> --help for the same information on the command line, and encore --version for the version.
Global flags
Section titled “Global flags”These work with every command.
| Flag | Type | Default | Description |
|---|---|---|---|
--config, -c |
string | path to a YAML config file (env ENCORE_CONFIG) |
Commands that read the configuration also honour ENCORE_* environment variables and the config file; see the configuration reference.
encore gen
Section titled “encore gen”Developer tools for the interaction model.
encore gen lint
Section titled “encore gen lint”Check the interaction model and response sources.
encore gen lint [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--strict |
bool | fail on warnings too |
encore gen model
Section titled “encore gen model”Write interaction model JSON for one or more locales.
Builds interaction models from the embedded sources without library slot values. With –out, writes interactionModels/custom/<locale>.json under that directory (the skill package layout); otherwise prints a single locale to stdout.
encore gen model [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--invocation |
string | override the invocation name | |
--locale, -l |
stringSlice | all |
locales to build (default all) |
--out, -o |
string | write a skill package interactionModels tree here |
encore healthcheck
Section titled “encore healthcheck”Exit 0 if the local server is healthy.
encore healthcheck [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--server.address |
string | :8080 |
address the server listens on (default “:8080”) |
encore restore
Section titled “encore restore”Restore the database from a backup.
Restore the database from a backup in the configured storage. Stop Encore first; restore refuses to run while Encore is using the same data directory.
The backup is downloaded and checked before anything is replaced: it must be a sound SQLite database, its schema must not be newer than this Encore’s, and the configured secrets key must decrypt its secrets. The current database is then moved aside to encore.db.before-restore-<time> and the backup takes its place.
In stateless mode the backup is uploaded as the saved state instead, keeping the current state as the previous copy.
encore restore [key] [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--latest |
bool | restore the newest backup | |
--list |
bool | list the backups in the configured storage, newest first | |
--yes, -y |
bool | restore without asking for confirmation |
encore serve
Section titled “encore serve”Run the Encore server.
encore serve [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--log.format |
string | auto |
log format: auto, pretty (coloured), text or json (default “auto”: pretty on a terminal, text otherwise) |
--log.level |
string | info |
log level: debug, info, warn or error (default “info”) |
--server.address |
string | :8080 |
listen address (default “:8080”) |
encore version
Section titled “encore version”Print version information.
encore version [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--json |
bool | print as JSON |