OF-Scraper

https://of-scraper.gitbook.io/of-scraper
Admin
OF-Scraper is a command-line tool that downloads media from OnlyFans and enables bulk actions like...
Tokens:21,492
Snippets:429
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install project dependencies

Source: https://of-scraper.gitbook.io/of-scraper/installation/install-from-source.md

Install or reinstall all project dependencies using uv.

```bash
uv sync --reinstall
```

--------------------------------

### Manual Mode Example

Source: https://of-scraper.gitbook.io/of-scraper/command-reference/manual-mode-args.md

Example command to run manual mode with a specific URL.

```bash
ofscraper manual --url test
```

--------------------------------

### Metadata Check Example

Source: https://of-scraper.gitbook.io/of-scraper/command-reference/metadata-check-mode-options.md

A basic example of running the metadata command with the check argument.

```bash
ofscraper metadata -metadata check
```

--------------------------------

### Manage Multiple Profiles

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/advanced-args.md

Examples for setting and locating profiles for different accounts.

```bash
ofscraper --profile test
```

```text
config file location=/home/test/.config/ofscraper/config.json
```

```text
profile location=/home/test/.config/ofscraper/test_profile
```

--------------------------------

### Example path output

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/migrating-from-digitalcriminals-script.md

Demonstrates the resulting directory structure based on the configured save_location and dir_format.

```markup
 "/Onlyfans/modelA/Messages/Free/Images/"
```

--------------------------------

### Install Development Releases

Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install.md

Installs either the latest pre-release or the bleeding-edge development version from GitHub.

```bash
uv tool install --prerelease allow ofscraper --force
```

```bash
uv tool install git+https://github.com/datawhores/OF-Scraper.git --force
```

--------------------------------

### Install with Optional Dependencies

Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install.md

Installs OF-Scraper with the optional pyffmpeg package included.

```bash
uv tool install ofscraper[ffmpeg] --force
```

--------------------------------

### Digitalcriminals Configuration Example

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/example-configs.md

An advanced configuration example featuring custom Python execution scripts and specific model price filtering logic.

```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"
        }
    }
}
```

--------------------------------

### Post Check Mode Examples

Source: https://of-scraper.gitbook.io/of-scraper/content-check-modes.md

Examples of using the post_check command with URL and file arguments.

```bash
ofscraper post_check --url url,url,url
```

```bash
ofscraper post_check --url url --url url
```

```bash
ofscraper post_check --file file
```

```bash
ofscraper post_check --file file --url url
```

--------------------------------

### Standard Configuration Example

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/example-configs.md

A basic configuration template defining file storage locations, download filters, and binary paths for ffmpeg and mp4decrypt.

```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"
        }
    }
}
```

--------------------------------

### Install Stable Release

Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install.md

Installs the latest stable version of OF-Scraper using UV.

```bash
uv tool install ofscraper --force
```

--------------------------------

### Install with Specific Python Version

Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install.md

Specifies the Python version to be used for the tool installation.

```bash
# Example: Install a specific script version with Python 3.12
uv tool install --prerelease allow ofscraper==<version> --python 3.12
```

--------------------------------

### Content Check Example

Source: https://of-scraper.gitbook.io/of-scraper/command-reference/content-check-mode-args.md

Example usage of the post_check subcommand with a URL argument.

```bash
ofscraper post_check --url test
```

--------------------------------

### Install Specific Version

Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install.md

Installs a specific version of the script by replacing the placeholder with the desired version number.

```bash
uv tool install --prerelease allow ofscraper==<version>
```

--------------------------------

### Generated Filename Example

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/customizing-save-path.md

The resulting path structure based on the provided file_options configuration.

```text
/home/James/Data/ofscraper/{model_username}/{responsetype}/
{mediatype}/{filename}.{ext}
```

--------------------------------

### Story Check Mode Examples

Source: https://of-scraper.gitbook.io/of-scraper/content-check-modes.md

Examples of using the story_check command with username and file arguments.

```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
```

--------------------------------

### Windows Path Formatting

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/customizing-save-path.md

Examples showing how to correctly format Windows file paths to avoid errors by escaping backslashes or using forward slashes.

```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
```

--------------------------------

### Scraper Execution Examples

Source: https://of-scraper.gitbook.io/of-scraper/command-reference/main-scraper-options.md

Common ways to invoke the scraper, including running with default settings or specifying a username.

```bash
ofscraper
```

```bash
ofscraper --username ALL
```

--------------------------------

### Message Check Mode Example

Source: https://of-scraper.gitbook.io/of-scraper/content-check-modes.md

Example of using the msg_check command with URL arguments.

```bash
ofscraper msg_check --url url,url,url
```

--------------------------------

### Paid Check Mode Examples

Source: https://of-scraper.gitbook.io/of-scraper/content-check-modes.md

Examples of using the paid_check command with username and file arguments.

```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
```

--------------------------------

### Perform HTTP GET request for documentation

Source: https://of-scraper.gitbook.io/of-scraper/using-prompts

Use this request to query the documentation index with a specific question and optional goal.

```http
GET https://of-scraper.gitbook.io/of-scraper/using-the-scraper/using-prompts.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Prioritize User Downloads

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/advanced-args.md

Adjusts the download order to fetch links for all selected users before starting downloads.

```bash
ofscraper --user-first
```

--------------------------------

### Force Update Content

Source: https://of-scraper.gitbook.io/of-scraper/content-check-modes.md

Example of using the --force argument to bypass cache and fetch fresh content.

```bash
ofscraper msg_check --url url --force
```

--------------------------------

### Create virtual environment

Source: https://of-scraper.gitbook.io/of-scraper/installation/install-from-source.md

Initialize a new virtual environment using uv.

```bash
uv venv
```

--------------------------------

### Prepare environment variables

Source: https://of-scraper.gitbook.io/of-scraper/installation/install-from-source.md

Source the script to configure environment variables for custom versioning.

```bash
source scripts/commit_version.sh
```

--------------------------------

### Clone the repository

Source: https://of-scraper.gitbook.io/of-scraper/installation/install-from-source.md

Download the project source code and navigate into the directory.

```bash
git clone https://github.com/datawhores/OF-Scraper/
cd OF-Scraper
```

--------------------------------

### Specify Configuration Path

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/advanced-args.md

Directs the program to a specific configuration folder or file.

```bash
ofscraper --config folder or file
```

--------------------------------

### Select All Models Shortcut

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/username-selection-or-fuzzy-search.md

Use this shortcut to select all available models.

```text
Ctrl+R
```

--------------------------------

### Dehumanize Date Strings

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/selecting-posts.md

Example of relative time strings used for date filtering.

```text
1 year ago, 1 month ago
```

--------------------------------

### Select specific models via command-line

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/model-selection-sorting.md

Use the --username argument to specify a comma-separated list of models or 'ALL' to select all users.

```bash
 ofscraper --username name1,name
```

```bash
 ofscraper --username ALL
```

--------------------------------

### Manual Mode Syntax

Source: https://of-scraper.gitbook.io/of-scraper/command-reference/manual-mode-args.md

Basic command structure for initiating manual mode.

```bash
ofscraper manual [options]
```

--------------------------------

### Available Placeholders for Path and Filename Configuration

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/customizing-save-path.md

A comprehensive list of placeholders that can be used to define dynamic directory paths and file naming patterns.

```text
{response_type}=Posts,Messages,Paid,etc
{post_id}= ID of post
{media_id} =ID of media

{file_name} = the filename, videos wills include the quality i.e source,720
{only_file_name}= the filename,videos will not include quality
{original_filename}= filename as sent by onlyfans, may or may not include source

{media_type}=Images,Audios,Videos
{quality} = quality of the media, none videos will always be source

{value}=The content's value: Whether it's categorized as Paid or Free.

{model_id}= Unique identification number for model

{first_letter}= first letter of model's username

{site_name} = Onlyfans
{text} = The text within the media. Truncation of file names has been tested to fit within OS limits, 
still it's advisable to establish a text length limit.
{date}= The date of the post, outputed in the config date format

{model_username} = The model's username
{username} = The model's username
{profile} = The currently active profile
{my_username}=The authorized account's username
{my_id} = The identification number 
for the  authorized account
{label} = The label assigned to the post, if available
{download_type}= Indication of whether it's protected or normal, 
determined by the necessity for decryption

{current_price}= Free if current price is 0 dollars else paid
{regular_price}=Free if regular price is 0 dollars else paid
{promo_price}= Free if promo price is 0 dollars else paid
{renewal_price}= Free if renewal price is 0 dollars else paid
{args}= the passed arguments namespace, keys can be access 
with the dot (.) syntax
{config}= the config arguments dictionary, keys can be access 
with the [] syntax
{modelObj} = model data class via class folder, properties can be access 
via the dot (.) syntax
{configPath} = path to current config directory
```

--------------------------------

### Select Post Types

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/selecting-posts.md

Specify post types to download using a comma-separated list or multiple flags.

```bash
 ofscraper --action download --posts highlights,timeline
```

```bash
 ofscraper --action download --posts highlights --posts timeline
```

--------------------------------

### Select All Models Alternative Shortcut

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/username-selection-or-fuzzy-search.md

An alternative shortcut to select all models.

```text
Ctrl+A
```

--------------------------------

### Linux or Mac Configuration Path

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/config-location.md

The default path for the configuration file on Linux or macOS systems.

```text
/home/username/.config/ofscraper/config.json
```

--------------------------------

### View Model Details Shortcut

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/username-selection-or-fuzzy-search.md

Displays full details for a selected model when the prompt menu is limited.

```text
Alt+D
```

--------------------------------

### Set Private Key Path

Source: https://of-scraper.gitbook.io/of-scraper/cdm-options.md

Specify the full file path for the private key in the configuration.

```json
private-key:...??privatekey.pem
```

--------------------------------

### Define Directory Format

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/remapping-responsetype.md

Set the directory structure using the responsetype placeholder.

```text
dir_format": "{model_username}/{responsetype}/{mediatype}/"
```

--------------------------------

### Shorthands for scraping all posts and labels

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/enable-label-scan.md

Use these shorthand commands to include labels while scraping all posts.

```bash
ofscraper --posts labels*
```

```bash
ofscraper --posts labels+
```

--------------------------------

### Activate virtual environment

Source: https://of-scraper.gitbook.io/of-scraper/installation/install-from-source.md

Activate the virtual environment to isolate project dependencies.

```bash
source .venv/bin/activate
```

--------------------------------

### Basic Scraper Syntax

Source: https://of-scraper.gitbook.io/of-scraper/command-reference/main-scraper-options.md

The standard command structure for executing the scraper.

```bash
ofscraper [options]
```

--------------------------------

### File Options Configuration

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/customizing-save-path.md

JSON configuration block defining the save location, directory structure, and file naming 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
        },
```

--------------------------------

### Basic Like and Unlike Actions

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/liking-unliking-post.md

Commands to perform a like or unlike action on posts.

```bash
 ofscraper --action like
```

```bash
 ofscraper --action unlike
```

--------------------------------

### Build OF-Scraper image with FFmpeg

Source: https://of-scraper.gitbook.io/of-scraper/installation/docker.md

Use this command to build a custom Docker image with the pyffmpeg package included via the INSTALL_FFMPEG build argument.

```bash
# Optional: Create a builder instance for multi-platform builds (recommended for cross-platform compatibility)
# docker buildx create --name mybuilder --use

# Navigate to the directory containing your Dockerfile (e.g., your cloned OF-Scraper repository)
# cd /path/to/OF-Scraper/repository

# Build the image, specifying the build-arg
docker buildx build --platform linux/amd64,linux/arm64 \
  --build-arg INSTALL_FFMPEG=true \
  -t my-ofscraper-image:latest \
```

--------------------------------

### Metadata path placeholders

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/setting-metadata-path.md

List of available placeholders for defining custom metadata paths in the configuration file.

```text
{sitename} = Onlyfans

{first_letter} = first letter of model's username

{model_username} = The model's username.

{model_id}= Unique identification number for model
{config_path}= The directory containing the config.json file
{profile} =The currently active profile
{save_location} = This option retrieves the parsed path specified in the 'save_location' 
option
{my_username}=The authorized account's username
{my_id} = The identification number assigned to the authorized account

{current_price}= Free if current price is 0 dollars else paid
{regular_price}=Free if regular price is 0 dollars else paid
{promo_price}= Free if promo price is 0 dollars else paid
{renewal_price}= Free if renewal price is 0 dollars else paid
```

--------------------------------

### Verify Auth File Formatting

Source: https://of-scraper.gitbook.io/of-scraper/faq.md

Check the formatting of the authentication file if login issues occur.

```text
check formatting of auth file
```

--------------------------------

### Windows Configuration Path

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/config-location.md

The default path for the configuration file on Windows systems.

```text
C:/Users/username/.config/ofscraper/config.json
```

--------------------------------

### Executing Multiple Actions

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/multiple-actions.md

Combines the like and download actions with specific area targets in a single command.

```bash
ofscraper --action like,download --like-area pinned --download-area timeline
```

--------------------------------

### Authentication File Structure

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/auth.md

The authentication file must be a JSON object containing the user agent, x-bc header, auth_id, session cookie, and auth_uid.

```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"
    }
}
```

--------------------------------

### Run metadata mode

Source: https://of-scraper.gitbook.io/of-scraper/page/creating-metadata.md

Executes the metadata subcommand to update data without downloading files.

```bash
ofscraper metadata [args]
```

--------------------------------

### Configure dir_format

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/migrating-from-digitalcriminals-script.md

Sets the directory structure template for organized file storage.

```json
 "dir_format": "{model_username}/{responsetype}/{value}/{mediatype}/"
```

--------------------------------

### Configure metadata path

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/migrating-from-digitalcriminals-script.md

Specifies the directory path for storing the user_data.db file.

```json
"metadata": "{save_location}/{model_username}/Metadata"
```

```json
"OnlyFans/ModelA/Metadata"
```

--------------------------------

### Performing Combined Actions

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions.md

Executes multiple actions such as liking and downloading content simultaneously or individually.

```bash
 ofscraper --posts all --action like,download
```

```bash
ofscraper --posts all --action download
```

--------------------------------

### Selecting Posts by Type

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/liking-unliking-post.md

Commands to filter which post types to like or unlike using comma-separated lists or multiple flags.

```bash
 ofscraper --action like --posts pinned,timeline
```

```bash
 ofscraper --action like --posts pinned --posts timeline
```

--------------------------------

### Configure Manual Key Mode

Source: https://of-scraper.gitbook.io/of-scraper/cdm-options.md

Set the default key mode to manual in the configuration file.

```yaml
key-mode-default:manual
```

--------------------------------

### Configure Cache Mode

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/advanced-config-options.md

Available cache storage backends for DiskCache.

```text
JSON
SQLITE
None (to disable)
```

--------------------------------

### Configure thread_count settings

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/performance-options.md

Defines the number of threads or workers for downloading, with 0 indicating the use of the main program thread.

```text
min=0
max=system
```

--------------------------------

### Command Syntax

Source: https://of-scraper.gitbook.io/of-scraper/command-reference/content-check-mode-args.md

General syntax for executing ofscraper subcommands.

```bash
ofscraper [subcommand_name] [subcommand_options]
```

--------------------------------

### Set Client ID Path

Source: https://of-scraper.gitbook.io/of-scraper/cdm-options.md

Specify the full file path for the client ID in the configuration.

```json
client-id:...??client_id.bin
```

--------------------------------

### Retrieve specific user lists

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/model-selection-sorting.md

Switches to a designated collection of accounts, supporting multiple lists.

```bash
ofscraper --userlist "tiktok"
```

```bash
ofscraper --userlist "tiktok" --userlist "tiktok2"
```

--------------------------------

### Include labels in all posts

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/enable-label-scan.md

Use this command to include labels when scraping all posts.

```bash
ofscraper --posts all,labels
```

--------------------------------

### Metadata Mode Command Syntax

Source: https://of-scraper.gitbook.io/of-scraper/command-reference/metadata-check-mode-options.md

The base command structure for executing metadata operations.

```bash
ofscraper metadata [options]
```

--------------------------------

### Configure save_location

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/migrating-from-digitalcriminals-script.md

Defines the base directory for downloaded content.

```json
 "save_location": "/Onlyfans",
```

--------------------------------

### Protobuf TypeError Workarounds

Source: https://of-scraper.gitbook.io/of-scraper/cdm-options/cdm-issues.md

Error message and suggested workarounds for protobuf version incompatibility issues.

```text
TypeError: Descriptors cannot not be created directly.
If this call came from a _pb2.py file, your generated code is out of date and 
must be regenerated with protoc >= 3.19.0.
If you cannot immediately regenerate your protos, some other possible workarounds are:

 1. Downgrade the protobuf package to 3.20.x or lower.
 2. Set PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python (but this will use pure-Python parsing and will be much slower).
```

--------------------------------

### Change Profile Location

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/advanced-args.md

Use this to specify a custom profile location, which takes precedence over the configuration file.

```bash
Change location of profile 
```

--------------------------------

### Combine multiple filters

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/model-selection-sorting.md

Apply multiple criteria to narrow down the target accounts.

```bash
ofscraper  --current-price paid --active-subscription --renewal-off --username ALL
```

```bash
ofscraper  --current-price free --active-subscription --username ALL
```

--------------------------------

### Restrict by account type

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/model-selection-sorting.md

Limits interaction to free accounts.

```bash
 ofscraper --current-price free --username ALL
```

--------------------------------

### Text File Placeholder Overrides

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/customizing-save-path.md

Displays the default placeholder values applied when processing text files.

```text
- filename is replace with text
- quality will always be Source
- media_type will always be "Text"
```

--------------------------------

### Pull latest tags

Source: https://of-scraper.gitbook.io/of-scraper/installation/install-from-source.md

Ensure all version information is available by pulling Git tags.

```bash
git pull --tags
```

--------------------------------

### Run OF-Scraper with Docker

Source: https://of-scraper.gitbook.io/of-scraper/installation/docker.md

Executes the OF-Scraper container with volume mounts for configuration and data. Replace {args} with specific scraper commands.

```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}
```

```bash
docker run -it --rm --name=ofscraper \
  -v /your/host/config/path/:/home/ofscraper/.config/ofscraper/ \
  -v /your/host/data/path/:/home/ofscraper/data \
  -e USER_NAME=youruser \
  -e USER_ID=$(id -u) \
  -e GROUP_ID=$(id -g) \
  -e GROUP_NAME=yourgroup \
  ghcr.io/datawhores/of-scraper:main ofscraper {args}
```

--------------------------------

### Filter by regular price

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/model-selection-sorting.md

Filters models based on their regular subscription price.

```bash
ofscraper  --regular-price paid 
```

--------------------------------

### Additional Model Selection Controls

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/username-selection-or-fuzzy-search.md

Access up-to-date key bindings during model selection.

```text
ALT+V | CTRL+V
```

--------------------------------

### SSL Verification Options

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/advanced-config-options.md

Available settings for controlling SSL certificate validation and TLS fingerprinting.

```json
"custom"
```

```json
"default"
```

```json
"false"
```

--------------------------------

### Set CDRM via Command Line

Source: https://of-scraper.gitbook.io/of-scraper/cdm-options.md

Pass the key-mode argument directly via the command line interface.

```bash
--key-mode cdrm
```

--------------------------------

### File Extension Placeholder

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/customizing-save-path.md

Placeholder specifically for the file extension of the media.

```text
{ext} = The file extension of the media
```

--------------------------------

### Run OF-Scraper with debug output

Source: https://of-scraper.gitbook.io/of-scraper/faq.md

Use these commands to generate debug logs for troubleshooting purposes.

```bash
ofscraper --output debug
```

```bash
ofscraper --log debug
```

--------------------------------

### Bypass Duplicate Check

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/selecting-posts.md

Force the download of all available content by ignoring the internal database check.

```bash
ofscraper --action download --force-all
```

--------------------------------

### Configure CDRM Key Mode

Source: https://of-scraper.gitbook.io/of-scraper/cdm-options.md

Set the default key mode to CDRM in the configuration file.

```yaml
key-mode-default:cdrm
```

--------------------------------

### Single Model Selection Navigation

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/username-selection-or-fuzzy-search.md

Use these keys to navigate and select a single model.

```text
END  |  HOME | PAGEUP | PAGEDOWN 
```

--------------------------------

### Permanently enable labels for all

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/enable-label-scan.md

Configure the setting to always include labels during all-post scans.

```text
override include_labels_all to True
```

--------------------------------

### Bypassing Prompts

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions.md

Automates execution by providing all required parameters via command-line arguments to skip interactive prompts.

```bash
 ofscraper --posts all --username ALL --action like,download
```

--------------------------------

### Define media filter options

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/download-options/media-filtering-options.md

Specifies the types of media to download, accepting a case-insensitive list of images, audios, or videos.

```text
Options are Images,Audios,Videos case insensitive
```

--------------------------------

### Network Drive Support Limitations

Source: https://of-scraper.gitbook.io/of-scraper/faq.md

Note regarding the limited support for network drives for media storage and lack of support for config/db files.

```text
Network Drives are have limited support for storing Media, but are not supported
at all for config files are db. 

Those should be stored on a local drive
```

--------------------------------

### Configure Hash Removal

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/advanced-config-options.md

Set the value to None to disable hash calculation, or False to calculate without removing files.

```text
Set value to None to disable calculating hash, False will calculate but not remove files
```

--------------------------------

### Scrape content from timeline post or purchase page

Source: https://of-scraper.gitbook.io/of-scraper/scraping-individual-posts-or-media.md

Use the manual command with a copied URL or post ID to scrape specific content.

```bash
ofscraper manual --url copied_link
```

```bash
ofscraper manual --url postid
```

--------------------------------

### Configure Responsetype Mapping

Source: https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/remapping-responsetype.md

Define the mapping between original response types and custom folder names.

```json
"timeline": "posts",
"message": "premium",
"archived": "archived",
"paid": "premium",
"stories": "stories",
"highlights": "stories",
 "profile": "profile"
```

--------------------------------

### Upgrade OF-Scraper

Source: https://of-scraper.gitbook.io/of-scraper/installation/uv-install.md

Upgrades the tool by first uninstalling the existing version to prevent conflicts.

```bash
uv tool uninstall ofscraper # Recommended first step
uv tool install ofscraper --force
```

```bash
uv tool uninstall ofscraper # Recommended first step
uv tool install --prerelease allow ofscraper --force
```

--------------------------------

### Skip Timed Posts

Source: https://of-scraper.gitbook.io/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/selecting-posts.md

Exclude promotional or timed posts from the download process.

```bash
ofscraper --action download --skip-timed
```
Tokens:
Raw