Skip to content
Suresh S edited this page Dec 11, 2024 · 3 revisions

Usage Guide

Running CineSync on Local Systems without docker

Note: All menu option features are fully configurable through the .env file. If you're using Docker, ensure that the configurations are set correctly within the .env file before pulling your Docker images. RTM (RealTime-Monitor) will be started automatically once the full scan is completed.

CineSync provides a user-friendly interface for managing your debrid library. Upon running the script, you'll be presented with a main menu where you can choose from various options.

Linux

python3 CineSync.py

Windows

python CineSync.py

Main Menu

  • 1) Edit .env file: Update Basic Configurations in this file.

  • 2) Full Library Scan: Perform a comprehensive scan of your entire library.

Full_Scan Full_ScanOP Full_ScanOP2 Full_ScanOP3
  • 3) Remove Broken Symlinks : Identify and remove broken symbolic links within your library.

  • 4) Exit: Quit the CineSync application.

Single File/Folder Symlink Creation

Linux

To create a symlink for a single media file or folder, run the following command:

python3 MediaHub/main.py "/path/to/your/media/file"

Windows

On Windows, use the following command:

python MediaHub/main.py "/path/to/your/media/file"

Auto-Selection for TMDB/IMDB

If you want to automatically select the best match from TMDB or IMDB, you can use the --auto-select flag at the end of the command. This flag will automatically pick the first best approach.

python3 MediaHub/main.py "/path/to/your/media/file" --auto-select

This will save you time by letting the script automatically choose the most relevant option.

Key Improvements:

  • Clear sectioning: I separated each platform (Linux and Windows) for clarity.
  • Improved command formatting: I made sure the commands were presented in code blocks for better readability.
  • Auto-select explanation: I expanded the explanation of --auto-select to clarify its purpose and how it improves the process.

Best Practices

  • Always backup your library before first use
  • Start with a small test directory
  • Verify symlink creation