OF-Scraper
  • Welcome
  • Requirements
  • Install
    • Pre-Install Guides
      • Linux
      • Windows
      • Mac
    • PIPX Install
    • PIP Install
    • Binary Releases
    • Docker
    • Release Info
    • Managing Multiple Python Versions
  • Getting Started and Settings
    • Config Options
      • Config Location
      • General Options
      • File Output Options
        • Placeholders
        • Responsetype Placeholders
      • Download Options
        • Download Toggles
        • Media Filtering Options
        • Advanced Download Options
      • Setting metadata path
      • Binaries Options
      • CDM Options
      • Performance Options
        • Values to Pick
      • Script Options
      • Advanced config options
        • Changing Const Values
        • Mediatype overwrites
    • Depreciated Options
    • Auth
    • Controlling Output/Logs
    • Migrating from Digitalcriminal's script
  • Using the Scraper
    • Using Prompts
      • Old Menu
      • Page 2
    • Username selection or Fuzzy Search
    • Basic Automation with command-line
      • Basic Actions
        • Liking/Unliking Post
        • Downloading Content
          • Downloading Text Files
          • Downloading Purchases From Deleted Models
        • Multiple Actions
      • Model Filtering/Sorting
        • Price Filtering/Sort
      • Advanced Args
      • Scripting tips
      • Enable label scan
    • Recipes
      • Adding Proxy
      • Redownload Deleted Downloads
  • Content Check Modes
    • Table Columns
    • Table Management
      • Pre 3.10.7 filtering
  • Scraping Individual Posts or Media
  • Metadata
    • Schema
    • Creating Metadata
    • Metadata location
  • CDM Setup
    • CDM issues
  • FAQ/Common Issues
    • Page 1
  • Command Reference
    • Shared Options
      • General Program Options
        • Program Options
        • Logging Options
        • Filename Modification Options
        • Media Filters Options
        • Download Options
        • Advanced Program Options
      • Shared Scrape and Metadata Check Mode Options
        • User List Filter Options
          • Advanced User Filters
        • User Selection Options
        • Model Sorting & Processing Options
        • Content Options
        • Automation Options
        • Advanced Search & Processing Options
    • Main Scraper Options
    • Metadata Check Mode Options
    • Content Check Modes Options
    • Manual Mode Options
  • Request Change to Doc
  • Testing
Powered by GitBook
On this page
  • Syntax
  • example
  • General Options
  • Options
  • -md, --metadata [argument]
  • -ms, --mark-stray-locked [argument]
  • -sp, --scrape-paid [argument]
  1. Command Reference

Metadata Check Mode Options

PreviousMain Scraper OptionsNextContent Check Modes Options

Last updated 12 months ago

Metadata Mode inherits mosts options from the main/scraper mode, with a few options removed because they don't make sense outside of downloading

without --force-all or --force-model-unique media will be filter to only those that are set as not downloaded in the database

Syntax

ofscraper metadata [options]

example

ofscraper metadata -metadata check

General Options

Options

-md, --metadata [argument]

The --metadata argument is used to specify how metadata mode updates the db

Available Modes:

  • check - Updates metadata fields for the specified area via an API. This option does not check for new filenames.

  • update - This mode performs two actions:

    1. Updates download status and filenames based on the presence of actual files.

    2. Updates metadata fields for the specified area via an API.

  • complete - Marks the download as complete and updates metadata fields via an API. It also uses a new filename if one is available

-ms, --mark-stray-locked [argument]

Marks unmatched media items as locked.

Details:

  • This flag is designed to identify and manage media items retrieved using the --after and --before options (date range filtering) that cannot be retrieved again through the API (potentially due to deletion).

  • Media items with labels are excluded from being marked as locked.

  • Locking is applied on a per-API type basis, Timeline, Archived Posts, and Messages

  • This has no effect if --scrape-paid is the only argument

Use Case:

Use this option to manage media items that aren't retrievable via the APIs. Marking them as locked prevents main scraper from using these items to set the minimum date

-sp, --scrape-paid [argument]

The --scrape-paid argument is used to specify how metadata mode updates the db, for scrape paid content

The options are the same as --metadata

  • check - Updates metadata fields for the specified area via an API. This option does not check for new filenames.

  • update - This mode performs two actions:

    1. Updates download status and filenames based on the presence of actual files.

    2. Updates metadata fields for the specified area via an API.

  • complete - Marks the download as complete and updates metadata fields via an API. It also uses a new filename if one is available

Available Modes:

  • check - Updates metadata fields for the specified area via an API. This option does not check for new filenames.

  • update - This mode performs two actions:

    1. Updates download status and filenames based on the presence of actual files.

    2. Updates metadata fields for the specified area via an API.

  • complete - Marks the download as complete and updates metadata fields via an API. It also uses a new filename if one is available

General Program Options
Shared Scrape and Metadata Check Mode Options