trakts CLI Reference

All commands have descriptive help messages available. So in case of doubt, simply add --help to the (sub)command to see the help docs (Example: trakts autostart --help and trakts --help). For reference, the various available commands are:

• auth: Shows the status of the trakt authentication. If no token is found, or if the token in expired, it runs the authetication flow for trakt.tv
  You can pass --force option to make it ignore the existing token, and force the authentication again.

• autostart: Controls the autostart behaviour of the scrobbler

• backlog: Manage the backlog of watched media yet to be synced with trakt servers (mostly due to internet connectivity issues). Read this for more info

  • list: Lists all the files in the backlog

  • clear: Try to add the unsynced files to trakt history

• config: Edits the scrobbler config settings. See Configuration section for more details

  • list: This command will list the parameters in the config, along with their current values. Eg: trakts config list

    players.monitored = ['mpv', 'vlc']
    players.skip_interval = 5
    general.enable_notifs = True
    fileinfo.whitelist = ['/path/to/movies', '/path/to/anime', '/path/to/TV']
    

    Additionally, it also accepts a --all option, which can be used to list ALL the config parameters, including those not overriden by the user.

  • set: Set the value for a config parameter.

    • Separate multiple values with spaces. Eg: trakts config set players.monitored mpv vlc mpc-be

      User config updated with 'players.monitored = ['mpv', 'vlc', 'mpc-be']'
      

    • For values containing space(s), surround them with double-quotes. Eg: trakts config set fileinfo.whitelist D:\Media\Movies "C:\Users\My Name\Shows"

      User config updated with 'fileinfo.whitelist = ['D:\\Media\\Movies', 'C:\\Users\\My Name\\Shows']'
      

    • Use --add to avoid overwriting the previous list values (whitelist, monitored, etc.):
      trakts config set players.monitored mpv vlc
trakts config set --add players.monitored plex mpc-hc
      will have final value:

      User config updated with 'players.monitored = ['mpv', 'vlc', 'plex', 'mpc-hc']'
      

  • unset: Reset a config value to its default.

• init: Runs the initial setup of the scrobbler.

• log: Access the log file, mainly for debugging purposes.
  Subcommands: (Run as trakts log <subcommand>)

  • open: Opens the latest log file in your default editor.
  • path: Prints the location of the log file.

• plex: Command to run the auth flow for Plex. You can pass --force option to make it ignore the existing token, and force the authentication again.

• run: Run the scrobbler in the foreground. Mainly needed in case you have disabled the autostart service, and want to run the app manually.

• start: Starts the trakt-scrobbler service. If already running, does nothing.

  • Use --restart to force restart the service.

• status: Shows the status trakt-scrobbler service.

• stop: Stops the trakt-scrobbler service.

• whitelist: Shortcut command to add folder(s) to whitelist in config.

  • add: Add folder(s) to whitelist. Don't forget to restart the scrobbler (trakts start --restart) after this.
    Eg: trakts whitelist add D:\Media\Movies "C:\Users\My Name\Shows"
    For folders containing spaces, use double quotes

  • show: List the current folders in whitelist.

  • remove: Interactively remove folder(s) from whitelist.

  • test: Check whether the given file/folder is in the whitelist.