Puppeteer Sharp is a .NET library for controlling Chrome or Chromium from C#. Add the PuppeteerSharp NuGet package, launch a browser, open a page, and use the API to automate interactions or save screenshots and PDFs. It is a software library—not a browser or physical device—and your application also needs access to a compatible browser.
What is Puppeteer Sharp?
Puppeteer Sharp (also written Puppeteer-Sharp) is a .NET port of the official Node.js Puppeteer API. It controls a browser through browser automation protocols, providing a high-level way for .NET applications to navigate pages and interact with browser content. The project describes support for Chrome and Firefox and lists both Chrome DevTools Protocol (CDP) and WebDriver BiDi; those are project-documented capabilities, not a guarantee that every browser, protocol feature, or Puppeteer API behaves identically. See the Puppeteer Sharp project site and its NuGet package listing for current details.
It is useful when a .NET application needs to perform work in a real browser context—for example, rendering a JavaScript-heavy page, clicking through a workflow, generating a screenshot, or producing a PDF. It is not the right tool for every page-processing job: if all you need is to parse static HTML, a browser may add unnecessary setup and runtime cost.
What can you do with Puppeteer Sharp?
The project and package documentation describe use cases across page rendering, interaction, and testing. Examples include:
#1 Best Overall
- Capture screenshots and PDFs: Render a page in a browser and save an image or document.
- Automate UI workflows: Navigate pages, enter text, press keys, submit forms, and test user-facing flows.
- Render single-page applications: Load client-rendered content for crawling or prerendering.
- Inspect network behavior: Use network interception to observe or control requests.
- Support testing and diagnosis: Run browser automation in test environments, capture timeline traces for performance diagnosis, or test Chrome extensions.
These are documented capabilities, not comparative performance results. The project materials do not establish that Puppeteer Sharp is faster or more reliable than other .NET automation libraries, or that it has complete feature parity with the JavaScript Puppeteer package.
Install Puppeteer Sharp and prepare a browser
Install the NuGet package in the .NET project where you plan to use it:
dotnet add package PuppeteerSharpNuGet also supports adding the dependency through a PackageReference. After installation, make sure the application can launch or connect to a compatible browser. The package and project pages do not fully settle browser installation steps for every package version, operating system, and deployment environment, so check the current NuGet listing and project documentation for the version you install.
The NuGet listing reviewed for this article reports target assets for .NET Standard 2.0, .NET 8.0, and .NET 10. The project homepage also describes .NET Standard 2.0 and .NET 10 support, and says the library works with .NET Framework 4.6.1 and later, .NET Core, and modern .NET. Since framework targets depend on the package release, use the assets shown for the exact version you select rather than assuming every release supports the same targets. The package is listed under the MIT license.
For Linux, the package documentation notes an X-server requirement. That note is not a complete deployment guide: verify the current browser, system-library, display, and container requirements for your specific environment.
Launch a browser, navigate, and save a screenshot
The following minimal example follows the project’s documented flow: launch headless Chrome or Chromium, create a page, navigate to https://example.com, and save a screenshot. It assumes the application has a browser available in a location Puppeteer Sharp can use.
using PuppeteerSharp;
await using var browser = await Puppeteer.LaunchAsync(new LaunchOptions
{
Headless = true
});
await using var page = await browser.NewPageAsync();
await page.GoToAsync("https://example.com");
await page.ScreenshotAsync("screenshot.png");For a project using top-level statements, put the code in Program.cs after installing the package. In a project that does not enable implicit global usings, add the appropriate System namespace import for the framework and compiler setup. The example uses the API shape shown in the project’s quick start; check the documentation for your installed package version if method signatures have changed.
What the code does
LaunchAsyncstarts a browser process using the launch options.NewPageAsynccreates a page (tab) in that browser.GoToAsyncnavigates to the target URL.ScreenshotAsyncwrites the captured page image to the specified path.
The example does not add custom waits, authentication, viewport sizing, or screenshot options. Those choices depend on the page and the capture you need; consult the installed version’s project documentation before relying on version-sensitive options.
Choose between browser automation and a screenshot API
Puppeteer Sharp makes sense when the .NET application must drive a browser or participate in a broader UI workflow. If the task is simply to request a website screenshot, running and maintaining a browser process may be more setup than necessary. ScreenshotNeo is the first alternative to try for that narrower job: it returns screenshots or PDFs from one API request, removes supported cookie banners, popups, and chat widgets before capture, and bills only clean shots.
Or skip the browser setup
For a screenshot without managing a browser process, call ScreenshotNeo’s API. The example saves the response body as a WebP file; replace the target URL and provide your API key. See the ScreenshotNeo API documentation for request options and response details.
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://example.com -o shot.webpScreenshotNeo removes supported cookie/consent banners, newsletter popups, and chat widgets before capture; each cleanup step can be turned off. Bot checks, blank pages, timeouts, failed loads, and cache hits cost nothing, and responses identify the page verdict and billing status. Its MCP server offers take_screenshot, get_page_info, and capture_pdf tools for AI agents and MCP clients. The free plan includes 1,000 screenshots per month with no card; paid plans start at $5 for 3,000 screenshots.
Sign up for ScreenshotNeo’s free plan to get 1,000 screenshots a month with no card.
Common setup and capture problems
The browser does not launch
Puppeteer Sharp needs a compatible browser it can launch or access. Confirm that the browser is installed or otherwise available to the application, and check the launch configuration and package documentation for your version. Do not assume the JavaScript Puppeteer installation process applies to Puppeteer Sharp: they are related projects, but their exact setup behavior is not established as identical.
A Linux deployment fails at startup
The NuGet documentation notes an X-server requirement on Linux. Check whether your runtime environment provides the display support and browser dependencies required by the browser and package version you are using. A minimal container may need additional setup; the package note alone does not specify a complete list.
Rank #4
The screenshot is blank or misses page content
Check that navigation completed successfully and that the page had time to render its client-side content before capture. A page can return its initial document before a single-page application has finished displaying the content you want. The project lists SPA crawling and rendering as a use case, but page-specific readiness conditions still need to be handled by your application.
The project does not build for the target framework
Compare the project’s target framework with the assets and dependency requirements listed for the exact NuGet release you installed. Framework compatibility is version-sensitive; the homepage’s broad platform description should not replace the selected package’s framework information.
A Puppeteer JavaScript guide does not match the .NET API
Use Puppeteer Sharp documentation for C# method names and behavior. The upstream Puppeteer documentation describes the JavaScript project, including distinctions between puppeteer and puppeteer-core and its browser-installation behavior; those details provide family context but do not prove that Puppeteer Sharp has the same installation steps or every feature. See the upstream Puppeteer documentation index and installation guide for the JavaScript project.
Choosing a browser automation approach
Before adopting Puppeteer Sharp, match the tool to the job rather than choosing by name alone:
- Need to interact with a browser from .NET? Puppeteer Sharp is a documented option for navigation, input, screenshots, PDFs, and related automation.
- Need only a screenshot or PDF from a URL? Consider an API such as ScreenshotNeo to avoid setting up browser execution in your application.
- Need static HTML extraction? Evaluate whether a browser is necessary at all; browser rendering is valuable when scripts or interaction matter, but can be unnecessary for plain markup.
- Need a specific protocol or framework target? Check the project and package documentation for the precise release. The available descriptions list CDP and WebDriver BiDi and several .NET targets, but they do not establish full feature parity or a technical winner over Playwright or Selenium.
Puppeteer Sharp’s project site invites commercial users to sponsor Puppeteer Sharp; consult the project directly for current terms and support details.
Frequently Asked Questions
Is Puppeteer Sharp a .NET library or a standalone browser?
It is a .NET browser-automation library distributed through NuGet; it controls a browser rather than being one itself.
Does Puppeteer Sharp work with Firefox?
The project homepage describes Chrome and Firefox automation and lists CDP and WebDriver BiDi support. Confirm browser and protocol support for your specific package version in the project documentation.
Does Puppeteer Sharp support .NET 10?
The project homepage lists .NET 10, and the NuGet listing reviewed for this article reports a .NET 10 target asset. Check the live package listing for the release you intend to install.
Quick Recap
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
