Welcome to shub’s documentation!

shub is the Scrapinghub command line client. It allows you to deploy projects or dependencies, schedule spiders, and retrieve scraped data or logs without leaving the command line.

Contents

• Quickstart
  • Installation
  • Getting help
  • Basic usage
• Configuration
  • Where to configure shub
  • Defining target projects
  • The configuration options
  • Configuration via environment variables
  • Example configurations
  • Advanced use cases
• Deploying projects and dependencies
  • Deploying projects
  • Deploying dependencies
  • Choosing a Scrapy Cloud stack
• Scheduling jobs and fetching job data
• Deploying custom Docker images
  • Deployment
  • Create Docker image for existing Scrapy project
  • Commands
  • Troubleshooting
• Custom Images contract
  • Contract statements
  • Environment variables
  • Scrapy entrypoint
  • Scrapy addons
• Changes
  • 2.17.1 (2026-04-21)
  • 2.17.0 (2026-04-07)
  • 2.16.0 (2025-11-05)
  • 2.15.4 (2024-02-08)
  • 2.15.3 (2024-01-23)
  • 2.15.2 (2024-01-17)