Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.onlyfanskit.dev/llms.txt

Use this file to discover all available pages before exploring further.

onlyfanskit-cli ships the onlyfans command for connecting accounts, sending DMs, validating sessions, running health checks, and streaming events from scripts or your terminal. 
npm install -g onlyfanskit-cli
onlyfans --help

​
Conventions

  • All output goes to stdout; diagnostics go to stderr.
  • Pass --json for machine-parseable output (defaults to a human summary).
  • Exit codes: 0 success, 1 validation/usage error, 2 runtime/API failure.
  • Credentials come from the environment or --account <id> (looked up in the local account registry — see accounts:add).

​
Credentials

Set the session in your environment, or register named accounts with onlyfans accounts:add and select them per command with --account: 
export OF_COOKIE="<your-cookie>"
export OF_X_BC="<your-x-bc>"
export OF_USER_ID="<your-user-id>"

onlyfans whoami
See Commands for the full list.