-
-
Notifications
You must be signed in to change notification settings - Fork 14
Command‐Line Usage
The Fansly Scraper can be operated in two main modes:
- TUI Mode (Terminal User Interface): If you run the application with no flags, it will launch an interactive, menu-driven interface. This is the recommended way for most users to manage downloads and settings.
- CLI Mode (Command-Line Interface): For automation, scripting, or performing specific one-off tasks, you can use the command-line flags detailed below.
You can always see a list of available commands and flags by running:
./fansly-scraper --helpThese commands allow you to perform the primary functions of the scraper directly from your terminal.
This is useful for grabbing a specific piece of content without scraping an entire profile. You can use either the post's URL or just its ID.
# Using the full URL
./fansly-scraper --post "https://fansly.com/post/847276926014857216"
# Using just the post ID
./fansly-scraper --post 847276926014857216This is the core feature for bulk-downloading content from a specific creator.
# Download everything (timeline, messages, stories) from a creator
./fansly-scraper --username creator_username
# Or, more explicitly:
./fansly-scraper --username creator_username --download all
# Download only the timeline (posts)
./fansly-scraper --username creator_username --download timeline
# Download only messages
./fansly-scraper --username creator_username --download messages
# Download only stories
./fansly-scraper --username creator_username --download storiesCreators often organize content into different "Walls" (e.g., "Main Feed", "Premium", "Archive"). You can filter your download to a specific wall using its ID.
Note: If you specify a wall, the scraper defaults to downloading only the timeline. If you want messages and stories included as well, you must explicitly add
--download all.
# Download ONLY the timeline posts from a specific Wall
# (Automatically implies --download timeline)
./fansly-scraper --username creator_username --wall 793928278367805440
# Download a specific Wall timeline AND messages/stories
./fansly-scraper --username creator_username --wall 793928278367805440 --download allYou can toggle monitoring for a creator, which will automatically record their livestreams when the monitoring service is running.
# Toggle monitoring ON or OFF for a specific creator
./fansly-scraper --monitor creator_username
# Start the background monitoring service (will run in your current terminal)
./fansly-scraper monitor start
# Stop the background monitoring service
./fansly-scraper monitor stopYou can easily check for and install new versions of the scraper.
./fansly-scraper updateThe diagnosis suite is a powerful tool for troubleshooting problems. When you encounter an issue (e.g., content isn't downloading, you're seeing errors), running this suite and attaching the generated report to your GitHub issue is the best way to help us solve the problem quickly.
The suite runs a series of tests and generates a redacted report, keeping your sensitive information safe.
This runs the fundamental checks for configuration and authentication. It's the first step for any issue.
./fansly-scraper --diagnosisIf your issue is with a specific creator or post, you can run a more focused diagnosis.
# Run tests on a specific creator's timeline and messages
./fansly-scraper --diagnosis --creator creator_username
# Run tests on a specific post to check media counts and accessibility
./fansly-scraper --diagnosis --postID 847276926014857216
# You can also combine them
./fansly-scraper --diagnosis --creator creator_username --postID 847276926014857216If files are failing to save, you can perform a test download. This will download to a temporary system folder.
-
--level=2: Increases verbosity and enables the download test. -
--keep-tmp: Crucial for debugging. This flag prevents the temporary download folder from being deleted, allowing you to inspect the files and folders that were created. The report will print the full path to this folder.
# Perform a full diagnosis on a post, including a test download
# This is the most helpful command for "it's not downloading" issues.
./fansly-scraper --diagnosis --level=2 --postID 847276926014857216
# Perform a test download AND keep the temporary files for inspection
./fansly-scraper --diagnosis --level=2 --postID 847276926014857216 --keep-tmpWhen you run the diagnosis, it will save a file named diagnosis-report-YYYY-MM-DD_HH-MM-SS.txt. When creating a new issue on GitHub, please drag and drop this file into the issue description to attach it. This gives us the information we need to help you.