### Example of Metadata Check Mode Source: https://of-scraper.gitbook.io/of-scraper/command-reference/metadata-check-mode-options An example demonstrating how to initiate the metadata check mode. ```bash ofscraper metadata -metadata check ``` -------------------------------- ### Example Metadata Directory Source: https://of-scraper.gitbook.io/of-scraper/getting-started/migrating-from-digitalcriminals-script Shows an example of the full path for the metadata directory, based on the 'save_location' and 'model_username'. ```plaintext "OnlyFans/ModelA/Metadata" ``` -------------------------------- ### Example Auth JSON Configuration Source: https://of-scraper.gitbook.io/of-scraper/getting-started/auth This is an example of a typical auth.json file with populated authentication values. Ensure all fields are correctly filled for the scraper to work. ```json { "auth": { "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36", "x-bc": "fncx03r1ygvh26ezq4pe830l49xtj1a146e1x2av", "auth_id": "400000", "sess": "5pb18tyng144dqyzevbgfddnrz", "auth_uid_": "400000" } } ``` -------------------------------- ### Install Project Dependencies with uv Source: https://of-scraper.gitbook.io/of-scraper/installation/install-from-source Install all project dependencies using uv. The --reinstall flag ensures a clean state by reinstalling existing packages. ```bash uv sync --reinstall ``` -------------------------------- ### Install Latest Pre-release OF-Scraper Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install Install the latest pre-release version of OF-Scraper. The --prerelease allow flag is necessary for pre-release installations. ```bash uv tool install --prerelease allow ofscraper --force ``` -------------------------------- ### Example Post Check Command Source: https://of-scraper.gitbook.io/of-scraper/command-reference/content-check-mode-args Demonstrates how to initiate a post check for a specific URL. ```bash ofscraper post_check --url test ``` -------------------------------- ### File Output Configuration Example Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/customizing-save-path Shows a sample configuration for file output options, including save location, directory format, and file format. ```json "file_options": { "save_location": "/home/james/Data/ofscraper", "dir_format": "/{model_username}/{responsetype}/{mediatype}/", "file_format": "{filename}.{ext}", "textlength": 0, "space-replacer": " ", "date": "MM-DD-YYYY", "text_type_default": "letter", "truncation_default": true }, ``` -------------------------------- ### Manual Mode Example with URL Source: https://of-scraper.gitbook.io/of-scraper/command-reference/manual-mode-args An example of running the scraper in manual mode to download content from a specified URL. This is a common use case for direct downloads. ```bash ofscraper manual --url test ``` -------------------------------- ### Query Documentation Dynamically Source: https://of-scraper.gitbook.io/of-scraper/testing Perform an HTTP GET request to the current page URL with the 'ask' query parameter to get dynamic documentation answers. ```http GET https://of-scraper.gitbook.io/of-scraper/testing.md?ask= ``` -------------------------------- ### Query Documentation with GET Request Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/scripts Demonstrates how to query OF-Scraper documentation dynamically. Perform an HTTP GET request on the current page URL with the 'ask' query parameter to get specific information. ```http GET https://of-scraper.gitbook.io/of-scraper/using-the-scraper/scripts.md?ask= ``` -------------------------------- ### Install OF-Scraper with Specific Python Version Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install Specify the Python version UV should use for the tool installation by appending `--python `. This example installs a specific script version with Python 3.12. ```bash # Example: Install a specific script version with Python 3.12 uv tool install --prerelease allow ofscraper== --python 3.12 ``` -------------------------------- ### Install Tests with Poetry Source: https://of-scraper.gitbook.io/of-scraper/testing Use this command to install project dependencies including those required for testing. ```bash poetry install --with tests ``` -------------------------------- ### Generated Filename Example Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/customizing-save-path Illustrates how the directory and file format placeholders combine to create the final generated filename structure. ```text /home/James/Data/ofscraper/{model_username}/{responsetype}/ {mediatype}/{filename}.{ext} ``` -------------------------------- ### Querying Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/multiple-actions To get more information not present on the current page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained. ```http GET https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/multiple-actions.md?ask= ``` -------------------------------- ### Example Directory Path Source: https://of-scraper.gitbook.io/of-scraper/getting-started/migrating-from-digitalcriminals-script Illustrates a full directory path constructed using 'save_location' and 'dir_format'. The first part is the base save location, and the second part is the dynamically generated subdirectory structure. ```markup "/Onlyfans/modelA/Messages/Free/Images/" ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/performance-options To get additional information not directly on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained. ```http GET https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/performance-options.md?ask= ``` -------------------------------- ### Query Documentation Source: https://of-scraper.gitbook.io/of-scraper/getting-started/migrating-from-digitalcriminals-script Demonstrates how to dynamically query the documentation using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information or clarifications not explicitly present on the page. ```http GET https://of-scraper.gitbook.io/of-scraper/getting-started/migrating-from-digitalcriminals-script.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/installation/pre-install-guide Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and self-contained. ```http GET https://of-scraper.gitbook.io/of-scraper/installation/pre-install-guide.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://of-scraper.gitbook.io/of-scraper/command-reference/main-scraper-options Perform an HTTP GET request to ask a question about the documentation. The response includes answers and relevant excerpts. ```http GET https://of-scraper.gitbook.io/of-scraper/command-reference/main-scraper-options.md?ask= ``` -------------------------------- ### Dynamic Documentation Query Source: https://of-scraper.gitbook.io/of-scraper/command-reference/content-check-mode-args Shows how to query the documentation dynamically using the 'ask' query parameter with a GET request. ```http GET https://of-scraper.gitbook.io/of-scraper/command-reference/content-check-mode-args.md?ask= ``` -------------------------------- ### Querying Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/selecting-posts/deleted-models Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and self-contained. The response will contain a direct answer and relevant excerpts. ```http GET https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/selecting-posts/deleted-models.md?ask= ``` -------------------------------- ### Install Latest Stable OF-Scraper Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install Use this command to install the most recent stable release of OF-Scraper. The --force flag ensures a fresh installation. ```bash uv tool install ofscraper --force ``` -------------------------------- ### Default Configuration Example Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/example-configs This is a comprehensive default configuration. It specifies save locations, directory and file formats, binary paths for mp4decrypt and ffmpeg, and various download and performance options. It also includes response type mappings. ```json { "config": { "main_profile": "main_profile", "metadata": "{configpath}/{profile}/.data/{model_username}_{model_id}", "discord": "", "file_options": { "save_location": "/home/james/Data/ofscraper", "dir_format": "/{model_username}/{responsetype}/{mediatype}/", "file_format": "{filename}.{ext}", "textlength": 0, "space-replacer": " ", "date": "MM-DD-YYYY", "text_type_default": "letter", "truncation_default": true }, "download_options": { "file_size_limit": 0, "file_size_min": 0, "filter": [ "Images", "Audios", "Videos" ], "auto_resume": false, "system_free_min": 0, "number_retries": 10 }, "binary_options": { "mp4decrypt": "/home/james/.config/ofscraper/bin/mp4decrypt", "ffmpeg": "/home/james/.config/ofscraper/bin/ffmpeg" }, "cdm_options": { "private-key": "/home/james/.config/ofscraper/device/private_key.pem", "client-id": "/home/james/.config/ofscraper/device/client_id.bin", "key-mode-default": "manual" }, "performance_options": { "download-sems": 10, "threads": 10 }, "advanced_options": { "code-execution": true, "dynamic-mode-default": "dc", "backend": "aio", "downloadbars": false, "cache-mode": "sqlite", "appendlog": false, "custom_values": null, "sanitize_text": false, "avatar": true, "temp_dir": null }, "responsetype": { "timeline": "Posts", "message": "Messages", "archived": "Archived", "paid": "Messages", "stories": "Stories", "highlights": "Stories", "profile": "Profile", "pinned": "Posts" } } } ``` -------------------------------- ### Ask a Question via GET Request Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/selecting-posts Use this GET request to query the documentation index with a specific question. The response will contain a direct answer and relevant excerpts. ```http GET https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/selecting-posts.md?ask= ``` -------------------------------- ### Install OF-Scraper with pyffmpeg Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install Install OF-Scraper including the pyffmpeg package for bundled ffmpeg capabilities. This automatically installs pyffmpeg as a dependency. ```bash uv tool install ofscraper[ffmpeg] --force ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/installation/binary-releases Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' query parameter with a specific, self-contained question in natural language to get direct answers and relevant excerpts. ```http GET https://of-scraper.gitbook.io/of-scraper/installation/binary-releases.md?ask= ``` -------------------------------- ### Query Documentation with GET Request Source: https://of-scraper.gitbook.io/of-scraper/getting-started/advanced-customization Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' query parameter with a specific, natural language question. ```http GET https://of-scraper.gitbook.io/of-scraper/getting-started/advanced-customization.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/content-check-modes/table-management/pre-3.10.7-filtering To get information not directly on the page, make an HTTP GET request to the current page URL with an 'ask' query parameter containing your question. ```http GET https://of-scraper.gitbook.io/of-scraper/content-check-modes/table-management/pre-3.10.7-filtering.md?ask= ``` -------------------------------- ### Windows Path Warning Example Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/customizing-save-path Demonstrates the correct way to format Windows paths by escaping backslashes or using forward slashes to avoid errors. ```text C:\Users\John.config\ofscraper\bin\ffmpeg.exe => ``` ```text C:\Users\John.config\ofscraper\bin\ffmpeg.exe => C:/Users/John.config/ofscraper/bin/ffmpeg.exe ``` -------------------------------- ### Query documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/page/creating-metadata Perform an HTTP GET request to a documentation page with the 'ask' query parameter to dynamically query the documentation. The question should be specific and self-contained. The response includes the answer and relevant excerpts. ```http GET https://of-scraper.gitbook.io/of-scraper/page/creating-metadata.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/installation/docker To get additional information not directly present on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and self-contained. ```http GET https://of-scraper.gitbook.io/of-scraper/installation/docker.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/cdm-options To get information not directly on the page, send an HTTP GET request to the page URL with an 'ask' query parameter. The question should be specific and in natural language. ```http GET https://of-scraper.gitbook.io/of-scraper/cdm-options.md?ask= ``` -------------------------------- ### Query Documentation with GET Request Source: https://of-scraper.gitbook.io/of-scraper/getting-started Perform an HTTP GET request to a specific documentation URL with the 'ask' query parameter to dynamically query the documentation. Use this for questions not explicitly answered on the page or when clarification is needed. ```http GET https://of-scraper.gitbook.io/of-scraper/getting-started.md?ask= ``` -------------------------------- ### Install Development Version of OF-Scraper Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install Install the most recent development version directly from the GitHub repository. This is useful for testing the latest code changes. ```bash uv tool install git+https://github.com/datawhores/OF-Scraper.git --force ``` -------------------------------- ### Query Documentation Dynamically Source: https://of-scraper.gitbook.io/of-scraper/cdm-options/cdm-issues To get more information not present on the current page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained. ```http GET https://of-scraper.gitbook.io/of-scraper/cdm-options/cdm-issues.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://of-scraper.gitbook.io/of-scraper/command-reference/shared-options/scrape-metadata-options/post-filter-args Perform an HTTP GET request with the 'ask' query parameter to dynamically query this documentation. The question should be specific and self-contained. ```http GET https://of-scraper.gitbook.io/of-scraper/command-reference/shared-options/scrape-metadata-options/post-filter-args.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/example-configs Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. Use this when the answer is not explicitly present, requires clarification, or you want to retrieve related documentation sections. ```http GET https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/example-configs.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/general-options Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific, self-contained, and written in natural language. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. ```http GET https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/general-options.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/page Use this method to ask questions about the documentation when information is not explicitly present. The question should be specific and self-contained. The response includes a direct answer and relevant excerpts. ```http GET https://of-scraper.gitbook.io/of-scraper/page.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://of-scraper.gitbook.io/of-scraper/command-reference/shared-options/scrape-metadata-options To get more information not present on this page, you can query the documentation dynamically. Perform an HTTP GET request on the current page URL with the `ask` query parameter. ```http GET https://of-scraper.gitbook.io/of-scraper/command-reference/shared-options/scrape-metadata-options.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://of-scraper.gitbook.io/of-scraper/command-reference/shared-options/common-option-groups/advanced-args To get information not explicitly present on the page, perform an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and self-contained. ```http GET https://of-scraper.gitbook.io/of-scraper/command-reference/shared-options/common-option-groups/advanced-args.md?ask= ``` -------------------------------- ### Query Documentation Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/download-options/advanced-download-options Perform an HTTP GET request to query the documentation dynamically. Use the `ask` query parameter with a specific, self-contained question in natural language. ```http GET https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/download-options/advanced-download-options.md?ask= ``` -------------------------------- ### GET Request to Ask Documentation Source: https://of-scraper.gitbook.io/of-scraper/content-check-modes/table-management Perform an HTTP GET request on the current page URL with the `ask` query parameter to query documentation dynamically. The question should be specific, self-contained, and written in natural language. The response will contain a direct answer and relevant excerpts. ```http GET https://of-scraper.gitbook.io/of-scraper/content-check-modes/table-management.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/using-prompts/page-2 Perform an HTTP GET request on a documentation page URL, appending the 'ask' query parameter with a natural language question to retrieve specific information. ```http GET https://of-scraper.gitbook.io/of-scraper/using-the-scraper/using-prompts/page-2.md?ask= ``` -------------------------------- ### Ask a Question via GET Request Source: https://of-scraper.gitbook.io/of-scraper/using-prompts Use this endpoint to ask specific questions about the documentation. The question should be self-contained and in natural language. The response includes direct answers and relevant excerpts. ```http GET https://of-scraper.gitbook.io/of-scraper/using-the-scraper/using-prompts.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options Perform an HTTP GET request to the current page URL with the `ask` query parameter to dynamically query the documentation. Use this when the answer is not explicitly present, for clarification, or to retrieve related documentation sections. ```http GET https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://of-scraper.gitbook.io/of-scraper/command-reference/shared-options/scrape-metadata-options/account-sorting-args Perform an HTTP GET request to the current page URL with the `ask` query parameter to dynamically query the documentation. This is useful for retrieving specific information not explicitly present on the page. ```http GET https://of-scraper.gitbook.io/of-scraper/command-reference/shared-options/scrape-metadata-options/account-sorting-args.md?ask= ``` -------------------------------- ### Run Tests with Pytest Source: https://of-scraper.gitbook.io/of-scraper/testing Execute the entire test suite using pytest after installation. ```bash pytest ``` -------------------------------- ### Minimal Docker Run Command Source: https://of-scraper.gitbook.io/of-scraper/installation/docker This command starts the OF-Scraper container with default user settings and maps host directories for configuration and data. Replace placeholders with your actual host paths and desired OF-Scraper arguments. ```bash docker run -it --rm --name=ofscraper \ -v /your/host/config/path/:/home/ofscraper/.config/ofscraper/ \ -v /your/host/data/path/:/home/ofscraper/data \ ghcr.io/datawhores/of-scraper:main ofscraper {args} ``` -------------------------------- ### Get Model Detail Shortcut Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/username-selection-or-fuzzy-search Use this shortcut to view all details for a specific model. This is useful when the prompt menu limits displayed data. ```text Alt+D ``` -------------------------------- ### Specify Private Key Path for CDM Source: https://of-scraper.gitbook.io/of-scraper/cdm-options Set the path to the private key file when using manual CDM setup. Ensure the complete file path is provided. ```json private-key:...??privatekey.pem ``` -------------------------------- ### Digitalcriminals Configuration Example Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/example-configs This configuration is tailored for Digitalcriminals, featuring specific metadata paths and advanced options including custom script execution and model price evaluation. Note the use of double slashes in binary paths. ```json { "config": { "main_profile": "main_profile", "metadata": "{save_location}/{model_username}/Metadata", "discord": "", "file_options": { "save_location": "//home/james/Data/ofscraper", "dir_format": "{model_username}/{responsetype}/{value}/{mediatype}/", "file_format": "{filename}.{ext}", "textlength": 0, "space-replacer": " ", "date": "MM-DD-YYYY", "text_type_default": "letter", "truncation_default": true }, "download_options": { "file_size_limit": 0, "file_size_min": 0, "filter": [ "Images", "Audios", "Videos" ], "auto_resume": false, "system_free_min": 0, "number_retries": 10 }, "binary_options": { "mp4decrypt": "//home/james/.config/ofscraper/bin/mp4decrypt", "ffmpeg": "//home/james/.config/ofscraper/bin/ffmpeg" }, "cdm_options": { "private-key": "//home/james/.config/ofscraper/device/private_key.pem", "client-id": "//home/james/.config/ofscraper/device/client_id.bin", "key-mode-default": "manual" }, "performance_options": { "download-sems": 10, "threads": 10 }, "advanced_options": { "code-execution": true, "dynamic-mode-default": "dc", "logs_expire_time": 0.0, "backend": "aio", "downloadbars": false, "cache-mode": "sqlite", "appendlog": false, "custom_values": {"MAXFILE_SEMAPHORE":10,"SHOW_AVATAR":false, "import":"exec('import ofscraper.filters.models.selector as selector23')", "list":"exec('modelObjs=C)')", "model_price":"'fallback' if len(modelObjs)==0 else 'Paid' if modelObjs[0].final_current_price>0 else 'Free'" }, "sanitize_text": false, "avatar": true, "temp_dir": null }, "script_options": { "post_download_script": null, "post_script": null }, "responsetype": { "timeline": "Posts", "message": "Messages", "archived": "Archived", "paid": "Messages", "stories": "Stories", "highlights": "Stories", "profile": "Profile", "pinned": "Posts" } } } ``` -------------------------------- ### Discord Webhook Configuration Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/general-options To send updates to Discord using webhooks, follow the setup guide at https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks. You'll need to add the URL provided in the setup and include the --discord argument when executing the script. ```text To send updates to Discord using webhooks, follow the setup guide at https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks. You'll need to add the URL provided in the setup and include the --discord argument when executing the script ``` -------------------------------- ### Example of ResponseType Remapping and File Saving Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/remapping-responsetype Illustrates the effect of response type remapping on file saving paths. Each line shows an original response type, its mapped type, and the resulting directory structure. ```plaintext timeline -> maps to posts -> files save to "{model_username}/Posts/{mediatype}/" messages -> maps to premium -> files save to "{model_username}/Premium/{mediatype}/" archived -> maps to archived -> files save to "{model_username}/Archived/{mediatype}/" paid -> maps to premium -> files save to "{model_username}/Premium/{mediatype}/" stories -> maps to stories -> files save to "{model_username}/Stories/{mediatype}/" highlight -> maps to stories -> files save to "{model_username}/Stories/{mediatype}/" profile -> maps to archived -> files save to "{model_username}/Profile/{mediatype}/" ``` -------------------------------- ### Story Check Mode Examples Source: https://of-scraper.gitbook.io/of-scraper/content-check-modes Collects stories and highlights using the provided username. Supports comma-separated usernames or multiple --username arguments, and a single --file argument for a list of usernames. ```bash ofscraper story_check --username username,username ``` ```bash ofscraper story_check --username username --username username ``` ```bash ofscraper story_check --file file ``` ```bash ofscraper story_check --file file --username username ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://of-scraper.gitbook.io/of-scraper/requirements Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. The question should be specific, self-contained, and written in natural language. ```http GET https://of-scraper.gitbook.io/of-scraper/requirements.md?ask= ``` -------------------------------- ### Paid Check Mode Examples Source: https://of-scraper.gitbook.io/of-scraper/content-check-modes This mode gathers paid content using the provided username. It supports comma-separated usernames or multiple --username arguments, and a single --file argument for a list of usernames. ```bash ofscraper paid_check --username username,username ``` ```bash ofscraper paid_check --username username --username username ``` ```bash ofscraper paid_check --file file ``` ```bash ofscraper paid_check --file file --username username ``` -------------------------------- ### Combine Download and Like Actions Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions Download all wall posts for a model and simultaneously like all posts. The '--posts all' argument selects all posts, and '--action like,download' specifies both actions. ```bash ofscraper --posts all --action like,download ``` -------------------------------- ### Download All Content Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/selecting-posts Use the '--force-all' argument to bypass the default duplicate check and download all available content for the current model. ```bash ofscraper --action download --force-all ``` -------------------------------- ### Install Specific Version of OF-Scraper Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install Install a specific stable or pre-release version of OF-Scraper by replacing `` with the desired version number (e.g., `2.4.3`). ```bash uv tool install --prerelease allow ofscraper== ``` -------------------------------- ### Download All, Like Pinned (Alternative Syntax) Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions An alternative syntax to download all posts and like only pinned posts. It uses '--posts all' for the general scope and '--like-area pinned' for the like action. ```bash ofscraper --posts all --like-area pinned --action like,download ``` -------------------------------- ### Basic Scraper Usage Source: https://of-scraper.gitbook.io/of-scraper/command-reference/main-scraper-options Run the scraper with default settings. ```bash ofscraper ``` -------------------------------- ### Set CDM Key Mode to CDRM Source: https://of-scraper.gitbook.io/of-scraper/cdm-options Configure the key mode to 'cdrm' in the configuration file for automated CDM setup. This is an alternative to manual setup. ```yaml key-mode-default:cdrm ``` -------------------------------- ### Set CDM Key Mode to Manual Source: https://of-scraper.gitbook.io/of-scraper/cdm-options Configure the key mode to 'manual' in the configuration file for CDM setup. This is part of the manual CDM setup process. ```yaml key-mode-default:manual ``` -------------------------------- ### Select All Models Shortcut Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/username-selection-or-fuzzy-search Use this shortcut to select all available models in the list. ```text Ctrl+R ``` -------------------------------- ### Download Media from File Source: https://of-scraper.gitbook.io/of-scraper/command-reference/manual-mode-args Use the -f or --file option to provide a file containing a list of URLs or post IDs for media downloads. Each item should be on a new line. ```bash ofscraper manual -f ``` -------------------------------- ### Message Check Mode Example Source: https://of-scraper.gitbook.io/of-scraper/content-check-modes Message check mode is equivalent to post check mode but accepts different post types for messages. All examples from post check mode are applicable here. ```bash ofscraper msg_check --url url,url,url ``` -------------------------------- ### Query Documentation API Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/username-selection-or-fuzzy-search To get additional information not directly on the page, make an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language. ```http GET https://of-scraper.gitbook.io/of-scraper/using-the-scraper/username-selection-or-fuzzy-search.md?ask= ``` -------------------------------- ### Performing Multiple Actions Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/multiple-actions Use this command to execute both 'like' and 'download' actions on specified areas. The `--like-area` and `--download-area` flags define the targets for these actions. ```bash ofscraper --action like,download --like-area pinned --download-area timeline ``` -------------------------------- ### Activate Python Virtual Environment Source: https://of-scraper.gitbook.io/of-scraper/installation/install-from-source Activate the newly created virtual environment. The prompt will change to indicate activation. ```bash source .venv/bin/activate ``` -------------------------------- ### Manual Mode Syntax Source: https://of-scraper.gitbook.io/of-scraper/command-reference/manual-mode-args This is the basic syntax for invoking the scraper in manual mode. Use this as a starting point for all manual mode commands. ```bash ofscraper manual [options] ``` -------------------------------- ### Download Media from URL Source: https://of-scraper.gitbook.io/of-scraper/command-reference/manual-mode-args Use the u or --url option to specify one or more URLs directly for media downloads. Separate multiple URLs with spaces. ```bash ofscraper manual -u ``` -------------------------------- ### Basic Syntax Source: https://of-scraper.gitbook.io/of-scraper/command-reference/content-check-mode-args Illustrates the fundamental command structure for using of-scraper with a subcommand and its options. ```bash ofscraper [subcommand_name] [subcommand_options] ``` -------------------------------- ### Specify Multiple Configurations Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/advanced-args Use the --config argument to point to a specific configuration folder or file. The program intelligently guesses the config location, stopping checks upon a successful match. ```bash ofscraper --config folder or file ``` -------------------------------- ### Select All Models Shortcut Alternative Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/username-selection-or-fuzzy-search An alternative shortcut to select all models. ```text Ctrl+A ``` -------------------------------- ### Case-Sensitive Search Example Source: https://of-scraper.gitbook.io/of-scraper/content-check-modes/table-management To perform a case-sensitive search, use upper case letters in your search query. This ensures that the search matches the exact casing provided. ```regex Dog ``` -------------------------------- ### Changing Config Location with Command-Line Argument Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/config-location Demonstrates how to specify a custom configuration file location using the --config option. ```bash GET https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/config-location.md?ask= ``` -------------------------------- ### Combine Filters for Specific Accounts Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/model-selection-sorting Combine multiple filters to target specific account types. For example, scrape paid accounts scheduled for expiration with active subscriptions. ```bash ofscraper --current-price paid --active-subscription --renewal-off --username ALL ``` ```bash ofscraper --current-price free --active-subscription --username ALL ``` -------------------------------- ### Specify Client ID Path for CDM Source: https://of-scraper.gitbook.io/of-scraper/cdm-options Set the path to the client ID file when using manual CDM setup. Ensure the complete file path is provided. ```json client-id:...??client_id.bin ``` -------------------------------- ### Download Text with Media Source: https://of-scraper.gitbook.io/of-scraper/command-reference/content-check-mode-args Use the -tn or --text flag to download text content along with any associated media. ```bash ofscraper [subcommand] --text ```