You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
27 KiB
27 KiB
Run Commands & Environment Variables
The basic command to run Kometa is as follows:
=== "Windows / Mac / Linux"
``` py
python kometa.py
```
=== "Docker"
``` py
docker run --rm -it -v "/<ROOT_KOMETA_DIRECTORY_HERE>/config:/config:rw" kometateam/kometa
```
To customize the running of Kometa according to your needs, you can use either run commands or environmental variables. Environmental variables take precedence over run command attributes. However, if you encounter a race condition where an attribute has been set both via an environmental variable and a shell command, the environmental variable will be given priority.
Please note that these instructions assume that you have a basic understanding of Docker concepts. If you need to familiarize yourself with Docker, you can check out the official tutorial.
Another way to specify environmental variables is by adding them to a .env file located in your config folder.
Environment variables are expressed as KEY=VALUE depending on the context where you are specifying them, you may enter
those two things in two different fields, or some other way. The examples below show how you would specify the
environment variable in a script or a docker run command. Things like Portainer or a NAS Docker UI will have
different ways to specify these things.
???+ warning "Combining Commands or Variables"
Some Commands or Variables can be combined in a single run, this is mainly beneficial when you want to run a specific command and have it run immediately rather than waiting until the next scheduled run.
For example, if I want to run [Collections Only](#collections-only) to only run Collection Files, and [Run Immediately](#run) to skip waiting until my next scheduled run, I can use both commands at the same time:
!!! example
=== "Local Environment"
```
python kometa.py --collections-only --run
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --collections-only --run
```
??? blank "Config Location -c/--config KOMETA_CONFIG¶"
<div id="config" />Specify the location of the configuration YAML file. Will default to `config/config.yml` when not
specified.
<hr style="margin: 0px;">
**Accepted Values:** Path to YAML config file
**Shell Flags:** `-c` or `--config` (ex. `--config /data/config.yml`)
**Environment Variable:** `KOMETA_CONFIG` (ex. `KOMETA_CONFIG=/data/config.yml`)
!!! example
=== "Local Environment"
```
python kometa.py --config /data/config.yml
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --config /data/config.yml
```
??? blank "Time to Run -t/--times KOMETA_TIMES¶"
<div id="times" />Specify the time of day that Kometa will run. Will default to `05:00` when not
specified.
<hr style="margin: 0px;">
**Accepted Values:** Comma-separated list in `HH:MM` format
**Shell Flags:** `-t` or `--times` (ex. `--times 06:00,18:00`)
**Environment Variable:** `KOMETA_TIMES` (ex. `KOMETA_TIMES=06:00,18:00`)
!!! example
=== "Local Environment"
```
python kometa.py --times 22:00,03:00
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --times 22:00,03:00
```
??? blank "Run Immediately -r/--run KOMETA_RUN¶"
<div id="run" />Perform a run immediately, bypassing the time to run flag.
<hr style="margin: 0px;">
**Shell Flags:** `-r` or `--run` (ex. `--run`)
**Environment Variable:** `KOMETA_RUN` (ex. `KOMETA_RUN=true`)
!!! example
=== "Local Environment"
```
python kometa.py --run
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --run
```
??? blank "Run Tests -ts/--tests KOMETA_TESTS¶"
<div id="tests" />Perform a debug test run immediately, bypassing the time to run flag. **This will only run
collections with `test: true` in the definition.**
<hr style="margin: 0px;">
**Shell Flags:** `-ts` or `--tests` (ex. `--tests`)
**Environment Variable:** `KOMETA_TESTS` (ex. `KOMETA_TESTS=true`)
!!! example
=== "Local Environment"
```
python kometa.py --tests
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --tests
```
=== "Example Collection File"
In my collection YAML file, I would set `true: false` like this:
```yaml
collections:
Marvel Cinematic Universe:
test: true # HERE
trakt_list: https://trakt.tv/users/jawann2002/lists/marvel-cinematic-universe-movies?sort=rank,asc
smart_label: release.desc
```
??? blank "Debug -db/--debug KOMETA_DEBUG¶"
<div id="debug" />Perform a debug test run immediately, bypassing the time to run flag. **This will only run
collections with `test: true` in the definition.**
<hr style="margin: 0px;">
**Shell Flags:** `-db` or `--debug` (ex. `--debug`)
**Environment Variable:** `KOMETA_DEBUG` (ex. `KOMETA_DEBUG=true`)
!!! example
=== "Local Environment"
```
python kometa.py --debug
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --debug
```
??? blank "Trace -tr/--trace KOMETA_TRACE¶"
<div id="trace" />Run with extra Trace Debug Logs.
<hr style="margin: 0px;">
**Shell Flags:** `-tr` or `--trace` (ex. `--trace`)
**Environment Variable:** `KOMETA_TRACE` (ex. `KOMETA_TRACE=true`)
!!! example
=== "Local Environment"
```
python kometa.py --trace
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --trace
```
??? blank "Log Requests -lr/--log-requests KOMETA_LOG_REQUESTS¶"
<div id="log-requests" />Run with every network request printed to the Logs. **This can potentially have personal
information in it.**
<hr style="margin: 0px;">
**Shell Flags:** `-lr` or `--log-requests` (ex. `--log-requests`)
**Environment Variable:** `KOMETA_LOG_REQUESTS` (ex. `KOMETA_LOG_REQUESTS=true`)
!!! example
=== "Local Environment"
```
python kometa.py --log-requests
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --log-requests
```
??? blank "Timeout -ti/--timeout KOMETA_TIMEOUT¶"
<div id="timeout" />Change the timeout for all non-Plex services (such as TMDb, Radarr, and Trakt). This will default to `180` when not specified and is overwritten by any timeouts mentioned for specific services in the Configuration File.
<hr style="margin: 0px;">
**Accepted Values:** Integer Number of Seconds
**Shell Flags:** `-ti` or `--timeout` (ex. `--timeout 06:00,18:00`)
**Environment Variable:** `KOMETA_TIMEOUT` (ex. `KOMETA_TIMEOUT=06:00,18:00`)
!!! example
=== "Local Environment"
```
python kometa.py --timeout 360
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --timeout 360
```
??? blank "Collections Only -co/--collections-only KOMETA_COLLECTIONS_ONLY¶"
<div id="collections-only" />Only run collection YAML files, skip library operations, metadata, overlays, and playlists.
<hr style="margin: 0px;">
**Shell Flags:** `-co` or `--collections-only` (ex. `--collections-only`)
**Environment Variable:** `KOMETA_COLLECTIONS_ONLY` (ex. `KOMETA_COLLECTIONS_ONLY=true`)
!!! example
=== "Local Environment"
```
python kometa.py --collections-only
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --collections-only
```
??? blank "Metadata Only -mo/--metadata-only KOMETA_METADATA_ONLY¶"
<div id="metadata-only" />Only run metadata files, skip library operations, collections, overlays, and playlists.
<hr style="margin: 0px;">
**Shell Flags:** `-mo` or `--metadata-only` (ex. `--metadata-only`)
**Environment Variable:** `KOMETA_METADATA_ONLY` (ex. `KOMETA_METADATA_ONLY=true`)
!!! example
=== "Local Environment"
```
python kometa.py --metadata-only
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --metadata-only
```
??? blank "Playlists Only -po/--playlists-only KOMETA_PLAYLISTS_ONLY¶"
<div id="playlists-only" />Only run playlist YAML files, skip library operations, overlays, collections, and metadata.
<hr style="margin: 0px;">
**Shell Flags:** `-po` or `--playlists-only` (ex. `--playlists-only`)
**Environment Variable:** `KOMETA_PLAYLISTS_ONLY` (ex. `KOMETA_PLAYLISTS_ONLY=true`)
!!! example
=== "Local Environment"
```
python kometa.py --playlists-only
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --playlists-only
```
??? blank "Operations Only -op/--operations-only KOMETA_OPERATIONS_ONLY¶"
<div id="operations-only" />Only run library operations skipping collections, metadata, playlists, and overlays.
<hr style="margin: 0px;">
**Shell Flags:** `-op` or `--operations-only` (ex. `--operations-only`)
**Environment Variable:** `KOMETA_OPERATIONS_ONLY` (ex. `KOMETA_OPERATIONS_ONLY=true`)
!!! example
=== "Local Environment"
```
python kometa.py --operations-only
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --operations-only
```
??? blank "Overlays Only -ov/--overlays-only KOMETA_OVERLAYS_ONLY¶"
<div id="overlays-only" />Only run library overlay files skipping collections, metadata, playlists, and operations.
<hr style="margin: 0px;">
**Shell Flags:** `-ov` or `--overlays-only` (ex. `--overlays-only`)
**Environment Variable:** `KOMETA_OVERLAYS_ONLY` (ex. `KOMETA_OVERLAYS_ONLY=true`)
!!! example
=== "Local Environment"
```
python kometa.py --overlays-only
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --overlays-only
```
??? blank "Run Collections -rc/--run-collections KOMETA_RUN_COLLECTIONS¶"
<div id="run-collections" />Perform a collections run immediately to run only the pre-defined collections, bypassing
the time to run flag.
<hr style="margin: 0px;">
**Accepted Values:** Pipe-separated list of Collection Names to run; the "pipe" character is "|" as shown in the examples below.
**Shell Flags:** `-rc` or `--run-collections` (ex. `--run-collections "Harry Potter|Star Wars"`)
**Environment Variable:** `KOMETA_RUN_COLLECTIONS` (ex. `KOMETA_RUN_COLLECTIONS=Harry Potter|Star Wars`)
!!! example
=== "Local Environment"
```
python kometa.py --run-collections "Harry Potter|Star Wars"
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --run-collections "Harry Potter|Star Wars"
```
??? blank "Run Libraries -rl/--run-libraries KOMETA_RUN_LIBRARIES¶"
<div id="run-libraries" />Perform a libraries run immediately to run only the pre-defined libraries, bypassing the
time to run flag.
<hr style="margin: 0px;">
**Accepted Values:** Pipe-separated list of Library Names to run; the "pipe" character is "|" as shown in the examples below.
**Shell Flags:** `-rl` or `--run-libraries` (ex. `--run-libraries "Movies - 4K|TV Shows - 4K"`)
**Environment Variable:** `KOMETA_RUN_LIBRARIES` (ex. `KOMETA_RUN_LIBRARIES=Movies - 4K|TV Shows - 4K`)
!!! example
=== "Local Environment"
```
python kometa.py --run-libraries "Movies - 4K|TV Shows - 4K"
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --run-libraries "Movies - 4K|TV Shows - 4K"
```
??? blank "Run Files -rf/--run-files KOMETA_RUN_FILES¶"
<div id="run-files" />Perform a run immediately to run only the pre-defined Collection, Metadata or Playlist files,
bypassing the time to run flag. This works for all different paths i.e. `default`, `git`, `url`, `file`, or `repo`.
???+ warning
Do not use this to run Overlay files, as Overlay files must run all together or not at all due to their nature.
<hr style="margin: 0px;">
**Accepted Values:** Pipe-separated list of Collection, Metadata or Playlist Filenames to run; the "pipe" character is "|" as shown in the examples below.
**Shell Flags:** `-rf` or `--run-files` (ex. `--run-files "Movies.yml|MovieCharts"`)
**Environment Variable:** `KOMETA_RUN_FILES` (ex. `KOMETA_RUN_FILES=Movies.yml|MovieCharts`)
!!! example
=== "Local Environment"
```
python kometa.py --run-files "Movies.yml|MovieCharts"
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --run-files "Movies.yml|MovieCharts"
```
??? blank "Ignore Schedules -is/--ignore-schedules KOMETA_IGNORE_SCHEDULES¶"
<div id="ignore-schedules" />Ignore all schedules for the run. Range Scheduled collections (such as Christmas
movies) will still be ignored.
<hr style="margin: 0px;">
**Shell Flags:** `-is` or `--ignore-schedules` (ex. `--ignore-schedules`)
**Environment Variable:** `KOMETA_IGNORE_SCHEDULES` (ex. `KOMETA_IGNORE_SCHEDULES=true`)
!!! example
=== "Local Environment"
```
python kometa.py --ignore-schedules
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --ignore-schedules
```
??? blank "Ignore Ghost -ig/--ignore-ghost KOMETA_IGNORE_GHOST¶"
<div id="ignore-ghost" />Ignore all ghost logging for the run. A ghost log is what's printed to the console to show
progress during steps.
<hr style="margin: 0px;">
**Shell Flags:** `-ig` or `--ignore-ghost` (ex. `--ignore-ghost`)
**Environment Variable:** `KOMETA_IGNORE_GHOST` (ex. `KOMETA_IGNORE_GHOST=true`)
!!! example
=== "Local Environment"
```
python kometa.py --ignore-ghost
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --ignore-ghost
```
??? blank "Delete Collections -dc/--delete-collections KOMETA_DELETE_COLLECTIONS¶"
<div id="delete-collections" />Delete all collections in a Library prior to running collections/operations.
???+ warning
You will lose **all** collections in the library - this will delete all collections, including ones not created
or maintained by Kometa.
<hr style="margin: 0px;">
**Shell Flags:** `-dc` or `--delete-collections` (ex. `--delete-collections`)
**Environment Variable:** `KOMETA_DELETE_COLLECTIONS` (ex. `KOMETA_DELETE_COLLECTIONS=true`)
!!! example
=== "Local Environment"
```
python kometa.py --delete-collections
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --delete-collections
```
??? blank "Delete Labels -dl/--delete-labels KOMETA_DELETE_LABELS¶"
<div id="delete-labels" />Delete all labels on every item in a Library prior to running collections/operations.
???+ warning
To preserve functionality of Kometa, this will **not** remove the Overlay label, which is required for Kometa to know
which items have Overlays applied.
This will impact any [Smart Label Collections](../files/builders/smart.md#smart-label) that you have in your
library.
We do not recommend using this on a regular basis if you also use any operations or collections that update
labels, as you are effectively deleting and adding labels on each run.
<hr style="margin: 0px;">
**Shell Flags:** `-dl` or `--delete-labels` (ex. `--delete-labels`)
**Environment Variable:** `KOMETA_DELETE_LABELS` (ex. `KOMETA_DELETE_LABELS=true`)
!!! example
=== "Local Environment"
```
python kometa.py --delete-labels
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --delete-labels
```
??? blank "Resume Run -re/--resume KOMETA_RESUME¶"
<div id="resume" />Perform a resume run immediately resuming from the first instance of the specified collection,
bypassing the time to run flag.
<hr style="margin: 0px;">
**Shell Flags:** `-re` or `--resume` (ex. `--resume "Star Wars"`)
**Environment Variable:** `KOMETA_RESUME` (ex. `KOMETA_RESUME=Star Wars`)
!!! example
=== "Local Environment"
```
python kometa.py --resume "Star Wars"
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --resume "Star Wars"
```
??? blank "No Countdown -nc/--no-countdown KOMETA_NO_COUNTDOWN¶"
<div id="no-countdown" />Run without displaying a countdown to the next scheduled run.
<hr style="margin: 0px;">
**Shell Flags:** `-nc` or `--no-countdown` (ex. `--no-countdown`)
**Environment Variable:** `KOMETA_NO_COUNTDOWN` (ex. `KOMETA_NO_COUNTDOWN=true`)
!!! example
=== "Local Environment"
```
python kometa.py --no-countdown
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --no-countdown
```
??? blank "No Missing -nm/--no-missing KOMETA_NO_MISSING¶"
<div id="no-missing" />Run without utilizing the missing movie/show functions.
<hr style="margin: 0px;">
**Shell Flags:** `-nm` or `--no-missing` (ex. `--no-missing`)
**Environment Variable:** `KOMETA_NO_MISSING` (ex. `KOMETA_NO_MISSING=true`)
!!! example
=== "Local Environment"
```
python kometa.py --no-missing
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --no-missing
```
??? blank "No Report -nr/--no-report KOMETA_NO_REPORT¶"
<div id="no-report" />Run without saving the report.
<hr style="margin: 0px;">
**Shell Flags:** `-nr` or `--no-report` (ex. `--no-report`)
**Environment Variable:** `KOMETA_NO_REPORT` (ex. `KOMETA_NO_REPORT=true`)
!!! example
=== "Local Environment"
```
python kometa.py --no-report
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --no-report
```
??? blank "Read Only Config -ro/--read-only-config KOMETA_READ_ONLY_CONFIG¶"
<div id="read-only-config" />Run without writing to the configuration file.
<hr style="margin: 0px;">
**Shell Flags:** `-ro` or `--read-only-config` (ex. `--read-only-config`)
**Environment Variable:** `KOMETA_READ_ONLY_CONFIG` (ex. `KOMETA_READ_ONLY_CONFIG=true`)
!!! example
=== "Local Environment"
```
python kometa.py --read-only-config
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --read-only-config
```
??? blank "Divider Character -d/--divider KOMETA_DIVIDER¶"
<div id="divider" />Change the terminal output divider character. Will default to `=` if not specified.
<hr style="margin: 0px;">
**Accepted Values:** Any character
**Shell Flags:** `-d` or `--divider` (ex. `--divider *`)
**Environment Variable:** `KOMETA_DIVIDER` (ex. `KOMETA_DIVIDER=*`)
!!! example
=== "Local Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --divider *
python kometa.py --divider *
```
=== "Docker Environment"
```
```
??? blank "Screen Width -w/--width KOMETA_WIDTH¶"
<div id="width" />Change the terminal output width. Will default to `100` if not specified.
<hr style="margin: 0px;">
**Accepted Values:** Integer between 90 and 300
**Shell Flags:** `-w` or `--width` (ex. `--width 150`)
**Environment Variable:** `KOMETA_WIDTH` (ex. `KOMETA_WIDTH=150`)
!!! example
=== "Local Environment"
```
python kometa.py --width 150
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --width 150
```
??? blank "Config Secrets --kometa-*** KOMETA_***¶"
<div id="kometa-vars" />All Run Commands that are in the format `--kometa-***` and Environment Variables that are in the
format `KOMETA_***`, where `***` is the name you want to call the variable, will be loaded in as Config Secrets.
These Config Secrets can be loaded into the config by placing `<<***>>` in any field in the config, where `***` is
whatever name you called the variable.
<hr style="margin: 0px;">
**Shell Flags:** `--kometa-***` (ex. `--kometa-mysecret 123456789`)
**Environment Variable:** `KOMETA_***` (ex. `KOMETA_MYSECRET=123456789`)
!!! example
=== "Local Environment"
```
python kometa.py --kometa-mysecret 123456789
```
=== "Docker Environment"
```
docker run -it -v "X:\Media\Kometa\config:/config:rw" kometateam/kometa --kometa-mysecret 123456789
```
**Example Config Usage:**
```yaml
tmdb:
apikey: <<mysecret>>
```