Skip to content

Latest commit

 

History

History
365 lines (260 loc) · 12 KB

Run-Commands-&-Environmental-Variables.md

File metadata and controls

365 lines (260 loc) · 12 KB
Raw
Name Shell Command Environmental
Variable		 Allowed Values Default Value
Config -c or --config PMM_CONFIG Path to YAML config file config/config.yml alongside
plex_meta_manager.py
Time to Run -t or --time PMM_TIME comma-separated list of times to update each day
Format: HH:MM		 03:00
Run -r or --run PMM_RUN Run without the scheduler False
Run Tests -rt, --tests, or --run-tests PMM_TEST Run in debug mode with only collections that have test: true False
Run Collections Only -co or --collections-only PMM_COLLECTIONS_ONLY Process only collections during the run False
Run Libraries Only -lo or --libraries-only PMM_LIBRARIES_ONLY Process everything but collections during the run False
Run Collections -rc or --run-collections PMM_COLLECTIONS comma-separated list of collection names to process All Collections
Run Libraries -rl or --run-libraries PMM_LIBRARIES comma-separated list of library names to process All Libraries
Run Metadata Files -rm or --run-metadata-files PMM_METADATA_FILES comma-separated list of metadata file names to process All Metadata Files
Run Libraries First -lf or --libraries-first PMM_LIBRARIES_FIRST Run library operations first before collections during the run False
Ignore Schedules -is or --ignore-schedules PMM_IGNORE_SCHEDULES Ignore all schedules during the run except for range schedules False
Delete Collections -dc or --delete-collections PMM_DELETE_COLLECTIONS Delete all collections in a Library before a run False
Resume Run -re or --resume PMM_RESUME Name of the Collection you want to resume the run at
No Countdown -nc or --no-countdown PMM_NO_COUNTDOWN Run without displaying the countdown False
No Missing -nm or --no-missing PMM_NO_MISSING Run without any of the missing movie/show functions False
Read Only Config -ro or --read-only-config PMM_READ_ONLY_CONFIG Run without writing to the config False
Divider Character -d or --divider PMM_DIVIDER Character that divides the sections =
Screen Width -w or --width PMM_WIDTH Integer between 90 and 300 100
  • Environmental Variable values are used over Shell Command values

Config

To choose the location of the YAML config file use the --config option.

Local 
python plex_meta_manager.py --config <path_to_config>
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --config <path_to_config>

Time to Run

To choose the times when the script will run each day use a comma-separated list with the --time option.

Local 
python plex_meta_manager.py --time 22:00,03:00
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --time 22:00,03:00

Run

To just run the script without having it continuously run use the --run option.

Local 
python plex_meta_manager.py --run
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run

Run Tests

To run the script in debug mode while only running collections that have test: true use the --run-tests option.

Local 
python plex_meta_manager.py --run-tests
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run-tests

Collections Only

To have the script run only collections and not any library operations use the --collections-only option.

Local 
python plex_meta_manager.py --collections-only
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --collections-only

Libraries Only

To have the script run only library operations and not any collections use the --libraries-only option.

Local 
python plex_meta_manager.py --libraries-only
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --libraries-only

Run Collections

To have the script run only using the collections in the comma-separated list use the --run-collections option.

Local 
python plex_meta_manager.py --run-collections "Harry Potter, Star Wars"
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run-collections "Harry Potter, Star Wars"

Run Libraries

To have the script run only the libraries in the comma-separated list use the --run-libraries option.

Local 
python plex_meta_manager.py --run-libraries "TV Shows"
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run-libraries "TV Shows"

Run Metadata Files

To have the script run only the Metadata File Names in the comma-separated list use the --run-metadata-files option.

Local 
python plex_meta_manager.py --run-metadata-files "Movies"
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run-metadata-files "Movies"
  • This works for all different metadata paths i.e. git, url, file, or repo.

Run Libraries First

To have the script run library operations first before collections during the run use the --libraries-first option.

Local 
python plex_meta_manager.py --libraries-first
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --libraries-first

Ignore Schedules

To have the script ignore all schedules during the run except for range schedules use the --ignore-schedules option.

Local 
python plex_meta_manager.py --ignore-schedules
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --ignore-schedules

Delete Collections

To have the script delete all collections in a Library before a run use the --delete-collections option.

Local 
python plex_meta_manager.py --delete-collections
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --delete-collections

Resume Run

To have the script resume a run from a specific collection use the --resume option.

Local 
python plex_meta_manager.py --resume "Star Wars"
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --resume "Star Wars"

No Countdown

To have the script run without displaying a countdown use the --no-countdown option.

Local 
python plex_meta_manager.py --no-countdown
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --no-countdown

No Missing

To have the script run without any of the missing movie/show functions use the --no-missing option.

Local 
python plex_meta_manager.py --no-missing
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --no-missing

Read Only Config

To have the script run without writing to the config use the --read-only-config option.

Local 
python plex_meta_manager.py --read-only-config
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --read-only-config

Divider Character & Screen Width

To change the terminal output divider character or width use the --divider and --width options.

Local 
python plex_meta_manager.py --divider * --width 200
Docker 
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --divider * --width 200