|
| 1 | +--- |
| 2 | +title: Quick Start |
| 3 | +description: Capture your first full-page scrolling video in under a minute. Learn the basic commands and most common options. |
| 4 | +order: 2 |
| 5 | +--- |
| 6 | + |
| 7 | +## Your first capture |
| 8 | + |
| 9 | +The simplest Rollberry command takes just a URL: |
| 10 | + |
| 11 | +```bash |
| 12 | +npx rollberry capture https://example.com |
| 13 | +``` |
| 14 | + |
| 15 | +This will: |
| 16 | + |
| 17 | +1. Launch a headless Chromium browser |
| 18 | +2. Navigate to `https://example.com` |
| 19 | +3. Wait 1 second for the page to settle |
| 20 | +4. Scroll from top to bottom over 5 seconds |
| 21 | +5. Save an MP4 video to `./rollberry-output/` |
| 22 | + |
| 23 | +The output directory will contain the video file along with a `manifest.json` describing the capture. |
| 24 | + |
| 25 | +## Viewing the output |
| 26 | + |
| 27 | +After the capture completes, open the output directory to find your video: |
| 28 | + |
| 29 | +```bash |
| 30 | +ls ./rollberry-output/ |
| 31 | +``` |
| 32 | + |
| 33 | +You will see output similar to: |
| 34 | + |
| 35 | +``` |
| 36 | +capture-2026-03-19T10-30-00.mp4 |
| 37 | +manifest.json |
| 38 | +``` |
| 39 | + |
| 40 | +Open the MP4 file with any video player, or drag it into a browser window to preview. |
| 41 | + |
| 42 | +## Customizing the viewport |
| 43 | + |
| 44 | +By default, Rollberry captures at 1280x720 pixels. To capture at a different resolution, use the `--viewport` flag: |
| 45 | + |
| 46 | +```bash |
| 47 | +# Desktop full HD |
| 48 | +npx rollberry capture https://example.com --viewport 1920x1080 |
| 49 | + |
| 50 | +# Mobile viewport (iPhone-like) |
| 51 | +npx rollberry capture https://example.com --viewport 390x844 |
| 52 | + |
| 53 | +# Tablet viewport (iPad-like) |
| 54 | +npx rollberry capture https://example.com --viewport 768x1024 |
| 55 | +``` |
| 56 | + |
| 57 | +The viewport format is `WIDTHxHEIGHT` in pixels. |
| 58 | + |
| 59 | +## Adjusting scroll duration |
| 60 | + |
| 61 | +The `--duration` flag controls how long the scroll takes in seconds. A longer duration produces a slower, smoother scroll: |
| 62 | + |
| 63 | +```bash |
| 64 | +# Quick 3-second scroll |
| 65 | +npx rollberry capture https://example.com --duration 3 |
| 66 | + |
| 67 | +# Slow, detailed 15-second scroll |
| 68 | +npx rollberry capture https://example.com --duration 15 |
| 69 | +``` |
| 70 | + |
| 71 | +For very long pages, you may want to increase the duration to avoid scrolling too quickly. |
| 72 | + |
| 73 | +## Specifying the output directory |
| 74 | + |
| 75 | +By default, output goes to `./rollberry-output`. Use `--output` (or `-o`) to change this: |
| 76 | + |
| 77 | +```bash |
| 78 | +npx rollberry capture https://example.com -o ./my-captures |
| 79 | +``` |
| 80 | + |
| 81 | +## Practical examples |
| 82 | + |
| 83 | +Here are a few real-world usage patterns to get you started: |
| 84 | + |
| 85 | +**Capture a landing page at full HD:** |
| 86 | + |
| 87 | +```bash |
| 88 | +npx rollberry capture https://your-site.com \ |
| 89 | + --viewport 1920x1080 \ |
| 90 | + --duration 8 |
| 91 | +``` |
| 92 | + |
| 93 | +**Capture a mobile view with cookie banner hidden:** |
| 94 | + |
| 95 | +```bash |
| 96 | +npx rollberry capture https://your-site.com \ |
| 97 | + --viewport 390x844 \ |
| 98 | + --hide-selectors ".cookie-banner, .consent-dialog" |
| 99 | +``` |
| 100 | + |
| 101 | +**Capture a local development server:** |
| 102 | + |
| 103 | +```bash |
| 104 | +npx rollberry capture http://localhost:3000 \ |
| 105 | + --wait 2000 \ |
| 106 | + --duration 10 |
| 107 | +``` |
| 108 | + |
| 109 | +**Wait for a specific element before capturing:** |
| 110 | + |
| 111 | +```bash |
| 112 | +npx rollberry capture https://your-site.com \ |
| 113 | + --wait-for-selector ".hero-image" \ |
| 114 | + --duration 6 |
| 115 | +``` |
| 116 | + |
| 117 | +## What happens during a capture |
| 118 | + |
| 119 | +When you run a capture, Rollberry provides progress output in your terminal: |
| 120 | + |
| 121 | +``` |
| 122 | +Rollberry v0.1.3 |
| 123 | +Capturing: https://example.com |
| 124 | +Viewport: 1280x720 |
| 125 | +Duration: 5s |
| 126 | +FPS: 30 |
| 127 | +
|
| 128 | +[1/4] Launching browser... |
| 129 | +[2/4] Navigating to page... |
| 130 | +[3/4] Scrolling and capturing... |
| 131 | +[4/4] Encoding video... |
| 132 | +
|
| 133 | +Done! Output saved to ./rollberry-output/capture-2026-03-19T10-30-00.mp4 |
| 134 | +``` |
| 135 | + |
| 136 | +If anything goes wrong, Rollberry will display a clear error message. For help debugging issues, see the [Debugging](/docs/guides/debugging) guide. |
| 137 | + |
| 138 | +## Next steps |
| 139 | + |
| 140 | +Now that you know the basics, explore these topics: |
| 141 | + |
| 142 | +- [CLI Options Reference](/docs/reference/cli-options) — Full list of all available flags |
| 143 | +- [Capturing Multiple Pages](/docs/guides/multi-page) — Batch capture workflows |
| 144 | +- [Localhost Captures](/docs/guides/localhost) — Capture local dev servers |
| 145 | +- [Hiding Overlays](/docs/guides/hiding-overlays) — Remove cookie banners and sticky elements |
0 commit comments