Scheduling Parts of Kometa¶

Kometa allows you to schedule libraries, files, overlays, operations, and more so that runs can be tailored to suit your needs.

This is particularly handy for users who have a lot of libraries or run a lot of Metadata/Operations on their libraries.

Important:¶

These schedules do not trigger Kometa to run; they control what Kometa will do if it happens to be running at the scheduled time. weekly(sunday), for example, does not mean "run Kometa on Sunday to do this thing"; it means "If Kometa is running, and it's Sunday, do this thing".

If you want to control when Kometa itself runs, like if you want Kometa to only run on Tuesdays and Thursdays, see this page.

The scheduling options are:

• daily is the default when schedule is not specified.
• You can run Kometa multiple times per day but using the --time command line argument detailed on the Run Commands & Environmental Variables Page.
• You can have multiple scheduling options as a list. List entries use OR logic: the definition runs when any entry matches.
• Use all[...] to require every enclosed scheduling option to match.
• You can use the delete_not_scheduled setting to delete Collections that are skipped due to not being scheduled.

Library schedule modes¶

Library schedule modes limit the media items Kometa processes. Use an ordered list of schedule and mode mappings under a library's schedule attribute. Kometa uses the first matching entry; if none match, it skips the library.

libraries:
  Movies:
    schedule:
      - schedule: weekly(monday)
        mode: added(7)
      - schedule: weekly.not(monday)
        mode: full

The .not modifier inverts one schedule expression. For example, weekly.not(monday) matches every day except Monday.

index matches the first non-whitespace character in a Plex item's Sort Title, case-insensitively, and falls back to its title when no Sort Title is set. Ranges must be alphabetical and ascending.

Use items(...) to select specific items already present in the library. Accepted identifiers are tmdb:<id>, tvdb:<id>, imdb:tt<id>, and plex:<ratingKey>. Numeric IDs must be positive. Identifiers can be mixed and are matched with OR logic; duplicates select an item only once. IDs that do not match a library item select nothing and never expand the scope to the full library. TMDb IDs in a TV Show library are converted to TVDb IDs. Selecting a show also includes its seasons and episodes. Plex rating keys must identify top-level library items, such as movies, shows, or music artists; provider IDs apply to movies and shows.

libraries:
  Movies:
    schedule:
      - schedule: weekly(monday)
        mode: items(tmdb:550|tmdb:603)
      - schedule: weekly.not(monday)
        mode: full

The second entry is optional; without it, this library is skipped on other days. As with other library schedule modes, --ignore-schedules or explicitly selecting the library with --run-libraries bypasses its schedule and uses the full scope.

Use --run --mode full or KOMETA_MODE=full to choose one mode for every library in a run. This overrides configured library schedule modes, including unmatched entries. Other schedules, such as individual collection schedules and schedule_overlays, still apply unless you also use --ignore-schedules.

When a mode is not full, Kometa limits metadata, overlays, item operations, and collection additions to items in scope. It does not remove existing collection members or change custom collection ordering; run with full to reconcile the whole library.

Schedule Warning: monthly(31) will not run this month; November does not have a 31st day.
Use monthly(last) if you want to schedule for the last day of every month.

Multiple schedule values¶

Multiple schedule values in a YAML list use OR logic. This definition runs when the collection does not exist or when the date is within the range:

schedule:
  - non_existing
  - range(10/05-10/31)

Use all[...] for AND logic. This definition runs only when the collection does not exist and the date is within the range:

schedule: all[non_existing, range(10/05-10/31)]

Use a bar (|) inside hourly, monthly, or yearly schedules to accept any of several values. Monthly values can mix individual days and inclusive ranges:

# Runs on the 1st, 3rd, 5th, 7th, and every day from the 9th through the end of the month.
schedule: monthly(1|3|5|7|9-last)

Hourly schedules can likewise mix individual hours and hour ranges:

# Runs at 02:00, every hour from 05:00 through 07:00, and at 22:00.
schedule: hourly(2|5-7|22)

Examples¶

libraries:
  Movies:
    schedule: weekly(sunday) #(1)!
    collection_files:
      - file: config/Movies.yml
      - default: imdb
      - default: studio
      - default: genre
      - default: actor
    operations:
      mass_critic_rating_update: tmdb

libraries:
  Movies:
    collection_files:
      - file: config/Movies.yml
        schedule: weekly(monday)
      - default: imdb
        schedule: weekly(tuesday)
      - folder: config/Movies/
        schedule: weekly(wednesday)
      - default: genre
        schedule: weekly(thursday)
      - default: actor
        schedule: weekly(friday)
    metadata_files:
      - file: config/metadata.yml
        schedule: weekly(saturday)
playlist_files:
  - file: config/Playlists.yml
    schedule: weekly(sunday)

libraries:
  Movies:
    schedule_overlays: weekly(saturday) #(1)!
    overlay_files:
      - default: audio_codec
      - default: resolution
      - default: video_format

collections:
  TMDb Trending Weekly:
    tmdb_trending_weekly: 30
    sync_mode: sync
    schedule: weekly(sunday)
  TMDb Top Rated:
    tmdb_top_rated: 30
    sync_mode: sync
    schedule: #(1)!
     - monthly(1)
     - monthly(15)

libraries:
  Movies:
    collection_files:
      - default: imdb
    operations:
      schedule: weekly(friday) #(1)!
      mass_critic_rating_update: tmdb
      split_duplicates: true

libraries:
  Movies:
    collection_files:
      - default: imdb
    operations:
      - schedule: weekly(friday) #(1)!
        mass_critic_rating_update: tmdb
      - schedule: weekly(saturday) #(2)!
        split_duplicates: true

collections:
  Christmas:
    imdb_list: https://www.imdb.com/list/ls000096828/
    sync_mode: sync
    visible_home: range(12/01-12/31) #(1)!