webshot 0.1.0

A command-line tool for automated website screenshots and web scraping
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
use clap::{Parser, Subcommand};
use std::path::PathBuf;
use tracing::info;
use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
use webshot::{Browser, Config, Result, ScreenshotOptions};

#[derive(Parser)]
#[command(
    name = "webshot",
    version = env!("CARGO_PKG_VERSION"),
    about = "Take screenshots of websites from the command line",
    long_about = "A fast command-line tool for taking website screenshots, generating PDFs, \
                  and extracting web content. Built with Rust and Chrome DevTools."
)]
struct Cli {
    #[command(subcommand)]
    command: Option<Commands>,

    /// URL to screenshot (if no subcommand provided)
    #[arg(value_name = "URL")]
    url: Option<String>,

    /// Output file path
    #[arg(short, long, value_name = "FILE")]
    output: Option<PathBuf>,

    /// Viewport width
    #[arg(short, long, default_value = "1280")]
    width: u32,

    /// Viewport height
    #[arg(short = 'H', long, default_value = "800")]
    height: u32,

    /// CSS selector for element screenshot
    #[arg(short, long, value_name = "SELECTOR")]
    selector: Option<String>,

    /// JavaScript to execute before screenshot
    #[arg(short, long, value_name = "SCRIPT")]
    javascript: Option<String>,

    /// Wait for element to appear (CSS selector)
    #[arg(long, value_name = "SELECTOR")]
    wait_for: Option<String>,

    /// Timeout in seconds
    #[arg(short, long, default_value = "30")]
    timeout: u64,

    /// Enable retina/high-DPI mode
    #[arg(long)]
    retina: bool,

    /// JPEG quality (1-100, only for JPEG output)
    #[arg(short, long, value_parser = clap::value_parser!(u8).range(1..=100))]
    quality: Option<u8>,

    /// Wait time in seconds before taking screenshot
    #[arg(long, default_value = "0")]
    wait: u64,

    /// Custom user agent string
    #[arg(long)]
    user_agent: Option<String>,

    /// Verbose logging
    #[arg(short, long, action = clap::ArgAction::Count)]
    verbose: u8,

    /// Disable JavaScript
    #[arg(long)]
    no_javascript: bool,

    /// Custom Chrome/Chromium executable path
    #[arg(long)]
    chrome_path: Option<PathBuf>,

    /// Additional Chrome flags
    #[arg(long, action = clap::ArgAction::Append)]
    chrome_flag: Vec<String>,
}

#[derive(Subcommand)]
enum Commands {
    /// Take a single screenshot
    #[command(alias = "shot")]
    Screenshot {
        /// URL to screenshot
        url: String,
        /// Output file path
        #[arg(short, long)]
        output: Option<PathBuf>,
        /// Viewport width
        #[arg(short, long, default_value = "1280")]
        width: u32,
        /// Viewport height
        #[arg(short = 'H', long, default_value = "800")]
        height: u32,
        /// CSS selector for element screenshot
        #[arg(short, long)]
        selector: Option<String>,
        /// JavaScript to execute
        #[arg(short, long)]
        javascript: Option<String>,
        /// Wait for element
        #[arg(long)]
        wait_for: Option<String>,
        /// Timeout in seconds
        #[arg(short, long, default_value = "30")]
        timeout: u64,
        /// Enable retina mode
        #[arg(long)]
        retina: bool,
        /// JPEG quality
        #[arg(short, long)]
        quality: Option<u8>,
        /// Wait time before screenshot
        #[arg(long, default_value = "0")]
        wait: u64,
    },
    /// Generate PDF from webpage
    Pdf {
        /// URL to convert to PDF
        url: String,
        /// Output PDF file path
        #[arg(short, long)]
        output: Option<PathBuf>,
        /// Page format (A4, Letter, etc.)
        #[arg(long, default_value = "A4")]
        format: String,
        /// Landscape orientation
        #[arg(long)]
        landscape: bool,
        /// Print background graphics
        #[arg(long)]
        background: bool,
        /// Scale factor (0.1 to 2.0)
        #[arg(long, default_value = "1.0")]
        scale: f64,
        /// JavaScript to execute
        #[arg(short, long)]
        javascript: Option<String>,
        /// Wait for element
        #[arg(long)]
        wait_for: Option<String>,
        /// Timeout in seconds
        #[arg(short, long, default_value = "30")]
        timeout: u64,
    },
    /// Process multiple screenshots from YAML config
    Multi {
        /// Configuration file path
        config_file: PathBuf,
        /// Override output directory
        #[arg(short, long)]
        output_dir: Option<PathBuf>,
        /// Parallel processing (number of concurrent tasks)
        #[arg(short, long, default_value = "4")]
        parallel: usize,
    },
    /// Extract text content from webpage
    Text {
        /// URL to extract text from
        url: String,
        /// CSS selector for specific element
        #[arg(short, long)]
        selector: Option<String>,
        /// Output file (stdout if not specified)
        #[arg(short, long)]
        output: Option<PathBuf>,
        /// JavaScript to execute
        #[arg(short, long)]
        javascript: Option<String>,
        /// Wait for element
        #[arg(long)]
        wait_for: Option<String>,
        /// Timeout in seconds
        #[arg(short, long, default_value = "30")]
        timeout: u64,
    },
}

#[tokio::main]
async fn main() -> Result<()> {
    let cli = Cli::parse();

    // Initialize logging
    init_logging(cli.verbose);

    // Extract values we need from cli to avoid borrow checker issues
    let chrome_path = cli.chrome_path.clone();
    let chrome_flags = cli.chrome_flag.clone();
    let no_javascript = cli.no_javascript;
    let user_agent = cli.user_agent.clone();

    // Handle the command
    match cli.command {
        Some(Commands::Screenshot {
            url,
            output,
            width,
            height,
            selector,
            javascript,
            wait_for,
            timeout,
            retina,
            quality,
            wait,
        }) => {
            take_screenshot(
                &url, output, width, height, selector, javascript, wait_for, timeout, retina,
                quality, wait, chrome_path, chrome_flags, no_javascript, user_agent,
            )
            .await
        }
        Some(Commands::Pdf {
            url,
            output,
            format,
            landscape,
            background,
            scale,
            javascript,
            wait_for,
            timeout,
        }) => {
            generate_pdf(
                &url, output, &format, landscape, background, scale, javascript, wait_for,
                timeout, chrome_path, chrome_flags, no_javascript, user_agent,
            )
            .await
        }
        Some(Commands::Multi {
            config_file,
            output_dir,
            parallel,
        }) => process_config(&config_file, output_dir, parallel, chrome_path, chrome_flags, no_javascript).await,
        Some(Commands::Text {
            url,
            selector,
            output,
            javascript,
            wait_for,
            timeout,
        }) => {
            extract_text(&url, selector, output, javascript, wait_for, timeout, chrome_path, chrome_flags, no_javascript, user_agent).await
        }
        None => {
            // Default behavior: screenshot with URL as positional argument
            if let Some(url) = &cli.url {
                take_screenshot(
                    url,
                    cli.output,
                    cli.width,
                    cli.height,
                    cli.selector,
                    cli.javascript,
                    cli.wait_for,
                    cli.timeout,
                    cli.retina,
                    cli.quality,
                    cli.wait,
                    chrome_path,
                    chrome_flags,
                    no_javascript,
                    user_agent,
                )
                .await
            } else {
                eprintln!("Error: URL is required when no subcommand is provided");
                eprintln!("Use 'webshot --help' for usage information");
                std::process::exit(1);
            }
        }
    }
}

fn init_logging(verbose: u8) {
    let filter = match verbose {
        0 => "webshot=warn",
        1 => "webshot=info",
        2 => "webshot=debug",
        _ => "webshot=trace,headless_chrome=debug",
    };

    tracing_subscriber::registry()
        .with(
            tracing_subscriber::EnvFilter::try_from_default_env()
                .unwrap_or_else(|_| tracing_subscriber::EnvFilter::new(filter)),
        )
        .with(tracing_subscriber::fmt::layer().with_target(false))
        .init();
}

async fn take_screenshot(
    url: &str,
    output: Option<PathBuf>,
    width: u32,
    height: u32,
    selector: Option<String>,
    javascript: Option<String>,
    wait_for: Option<String>,
    timeout: u64,
    retina: bool,
    quality: Option<u8>,
    wait: u64,
    chrome_path: Option<PathBuf>,
    chrome_flags: Vec<String>,
    no_javascript: bool,
    user_agent: Option<String>,
) -> Result<()> {
    info!("Taking screenshot of: {}", url);

    let browser = Browser::new(
        chrome_path,
        chrome_flags,
        !no_javascript,
    )
    .await?;

    let options = ScreenshotOptions {
        width,
        height,
        selector,
        javascript,
        wait_for,
        timeout,
        retina,
        quality,
        wait,
        user_agent,
    };

    let output_path = output.unwrap_or_else(|| {
        PathBuf::from(format!(
            "screenshot_{}.png",
            chrono::Utc::now().format("%Y%m%d_%H%M%S")
        ))
    });

    browser.screenshot(url, &output_path, &options).await?;

    println!("Screenshot saved to: {}", output_path.display());
    Ok(())
}

async fn generate_pdf(
    url: &str,
    output: Option<PathBuf>,
    format: &str,
    landscape: bool,
    background: bool,
    scale: f64,
    javascript: Option<String>,
    wait_for: Option<String>,
    timeout: u64,
    chrome_path: Option<PathBuf>,
    chrome_flags: Vec<String>,
    no_javascript: bool,
    user_agent: Option<String>,
) -> Result<()> {
    info!("Generating PDF of: {}", url);

    let browser = Browser::new(
        chrome_path,
        chrome_flags,
        !no_javascript,
    )
    .await?;

    let output_path = output.unwrap_or_else(|| {
        PathBuf::from(format!(
            "page_{}.pdf",
            chrono::Utc::now().format("%Y%m%d_%H%M%S")
        ))
    });

    browser
        .pdf(
            url,
            &output_path,
            format,
            landscape,
            background,
            scale,
            javascript,
            wait_for,
            timeout,
            user_agent,
        )
        .await?;

    println!("PDF saved to: {}", output_path.display());
    Ok(())
}

async fn process_config(
    config_file: &PathBuf,
    output_dir: Option<PathBuf>,
    parallel: usize,
    chrome_path: Option<PathBuf>,
    chrome_flags: Vec<String>,
    no_javascript: bool,
) -> Result<()> {
    info!("Processing config file: {}", config_file.display());

    let config = Config::from_file(config_file)?;
    let browser = Browser::new(
        chrome_path,
        chrome_flags,
        !no_javascript,
    )
    .await?;

    browser.process_config(&config, output_dir, parallel).await?;

    println!("Batch processing completed successfully");
    Ok(())
}

async fn extract_text(
    url: &str,
    selector: Option<String>,
    output: Option<PathBuf>,
    javascript: Option<String>,
    wait_for: Option<String>,
    timeout: u64,
    chrome_path: Option<PathBuf>,
    chrome_flags: Vec<String>,
    no_javascript: bool,
    user_agent: Option<String>,
) -> Result<()> {
    info!("Extracting text from: {}", url);

    let browser = Browser::new(
        chrome_path,
        chrome_flags,
        !no_javascript,
    )
    .await?;

    let text = browser
        .extract_text(url, selector, javascript, wait_for, timeout, user_agent)
        .await?;

    match output {
        Some(path) => {
            std::fs::write(&path, &text)?;
            println!("Text saved to: {}", path.display());
        }
        None => {
            println!("{}", text);
        }
    }

    Ok(())
}