Skip to content

Latest commit

 

History

History
110 lines (68 loc) · 3.48 KB

readme.md

File metadata and controls

110 lines (68 loc) · 3.48 KB
Raw

url2thumb

Take screenshots of web sites from the command line in OS X.

Examples

This example will take a full size, full quality png screenshot.

./url2thumb -url "http://www.cnn.com/" -o cnn.png

This example shows all available flags, and will make a smaller 150x100 pixel JPEG thumbnail of the website.

./url2thumb -url "http://www.timestretch.com/ \
			-o "timestretch.jpg" \
			-viewWidth 1024 \
			-viewHeight 768 \
			-outputWidth 150 \
			-outputHeight 100 \
			-transparentWebView 0 \
			-quality 0.75

Flags

Only the "-url" and "-o" output file flags are required. The others are optional, but very useful to getting the desired output. If you omit any optional flags, the default values indicated below will be used.

URL Flag

Specify the URL to visit and take a screenshot. Only URLs that start with "http" and "https" are allowed. You may put urls in quotes that contain special characters such as ampersands.

-url "http://www.example.com/"

Output Filename (.jpg or .png)

Specify the output file name and path. The extension used for the output file may be ".png" or ".jpg". Quality for JPEGs may be specified with the -quality flag.

-o "/tmp/example.jpg"

View Port Size (Size of the Rendered Web Page)

Specify the initial viewport size in pixels, to contain the WebView. You may get the mobile version of the site by passing in a width of 320 or 480 pixels.

-viewWidth (default = 1024)
-viewHeight (default = 768)

Output Size (Scaled to this size after rendering)

If left blank, the resulting screenshot will be sized to contain the entire web view. This may result in a very large image thousands of pixels tall.

If you pass only the width, the image will be scaled proportionally to that width. If you pass both a width and a height, the image will first be scaled to the width, the cropped to the height.

-outputWidth (default = automatic)
-outputHeight (default = automatic)

Quality (JPG Compression, as a Percentage From 0.0 to 1.0)

If you specify and output file type of ".jpg", you can also pass in the -quality flag (between 0.01 and 1.0). If you don't specify a quality, 0.75 will be used.

-quality [0.0 - 1.0] (default = 0.75)

Generating Transparent Background PNGs

You can generate transparent background PNG files by rendering an HTML document that has the following CSS:

body {
	background: transparent;
}

And then enable the following flag when generating a PNG file.

-o "some.png" \
-transparentWebView 1

Warning: Shared-Session Issues

If you are logged in to a website in Safari or other browser that uses WebKit, your screenshots taken with url2thumb will reflect this. WebKit shares session data among all WebViews shared by a user. If you have any suggestions on how to fix this, please let me know.

To-Do

  • Pass in a time to wait before taking screenshot for pages with loading animations.
  • Deal with shared sessions issue mentioned above.

Changes

2015-07-21

  • Added option to enable transparent backgrounds.
  • Disabled font antialiasing which caused color fringing.

©2006-2015 Erik Wrenholt