context7.json

{
  "$schema": "https://context7.com/schema/context7.json",
  "projectTitle": "Xquik Ruby SDK",
  "description": "Official Ruby SDK for Xquik's X/Twitter API with typed methods for tweet search, user lookup, media workflows, monitors, webhooks, posting, and bulk extractions.",
  "branch": "main",
  "excludeFolders": [
    ".github",
    ".yardoc",
    "bin",
    "doc",
    "gemfiles",
    "sorbet",
    "test"
  ],
  "excludeFiles": [
    "CHANGELOG.md",
    "CODE_OF_CONDUCT.md",
    "CONTRIBUTING.md",
    "Gemfile.lock",
    "LICENSE",
    "SECURITY.md",
    "Tapiocafile",
    "rbi/todo.rbi"
  ],
  "rules": [
    "Install from RubyGems package x-twitter-scraper, then require x_twitter_scraper.",
    "Authenticate with XTwitterScraper::Client api_key or the X_TWITTER_SCRAPER_API_KEY environment variable.",
    "Use README.md first for install, authentication, first request, uploads, retries, errors, pagination, and common workflows.",
    "Use x_twitter_scraper.gemspec for package name, version, license, homepage, support URLs, Ruby version, files, and dependencies.",
    "Use lib/x_twitter_scraper/resources and lib/x_twitter_scraper/models for generated Ruby method names and typed request parameters.",
    "Use lib/x_twitter_scraper/resources/x/tweets.rb for tweet search, posting, replies, retweets, likes, and tweet retrieval workflows.",
    "Use lib/x_twitter_scraper/resources/x/media.rb, lib/x_twitter_scraper/resources/monitors.rb, lib/x_twitter_scraper/resources/webhooks.rb, and lib/x_twitter_scraper/resources/extractions.rb for media, monitoring, webhook, and bulk extraction workflows.",
    "Never expose API keys, bearer tokens, webhook signing values, user credentials, or local runtime secrets in examples, logs, or commits."
  ],
  "url": "https://context7.com/xquik-dev/x-twitter-scraper-ruby",
  "public_key": "pk_oCPeRRqZFJsY4cCUSotDD"
}