Installation

Astro Snapshot is available on both JSR and npm, so you can choose where you want to install it from. Either way, you get full type support.

JSR or npm?

JSR is a good choice if you’re using TypeScript or Deno. It ships typed, modern ESM code by default with no need for separate type declarations.

npm may be preferable if you’re using a Node-based project, as astro is resolved as a peer dependency which avoids potential version mismatch issues. It also works seamlessly with astro add.

Some package managers may block Puppeteer’s install scripts

If Puppeteer fails to download a browser during installation, refer to the Troubleshooting page.

Automatic (with astro add)

You can use the Astro CLI to install and set up the integration automatically using your preferred package manager.

Note

astro add installs from npm. To use the JSR version, follow the manual installation steps below.

npm

npx astro add @twocaretcat/astro-snapshot

pnpm

pnpm astro add @twocaretcat/astro-snapshot

yarn

yarn astro add @twocaretcat/astro-snapshot

bun

bunx astro add @twocaretcat/astro-snapshot

Deno

deno run -A astro add @twocaretcat/astro-snapshot

vlt

vlt astro add @twocaretcat/astro-snapshot

Manual

If you run into any issues, you can install the package manually instead.

1. Install

First, install the package using your preferred package manager.

npm

npm

npm install @twocaretcat/astro-snapshot

JSR

npx jsr add @twocaretcat/astro-snapshot

pnpm

npm

pnpm add @twocaretcat/astro-snapshot

JSR

pnpm i jsr:@twocaretcat/astro-snapshot

yarn

npm

yarn add @twocaretcat/astro-snapshot

JSR

yarn add jsr:@twocaretcat/astro-snapshot

bun

npm

bun add @twocaretcat/astro-snapshot

JSR

bunx jsr add @twocaretcat/astro-snapshot

Deno

npm

deno add npm:@twocaretcat/astro-snapshot

JSR (recommended)

deno add jsr:@twocaretcat/astro-snapshot

vlt

npm

vlt install @twocaretcat/astro-snapshot

JSR

vlt install jsr:@twocaretcat/astro-snapshot

2. Add to Config

Then add it to your astro.config.*.

astro.config.ts

import { defineConfig } from 'astro/config';
import snapshot from '@twocaretcat/astro-snapshot';

export default defineConfig({
  integrations: [],
  integrations: [snapshot({ pages: {} })],
});

Next, you’ll need to configure some pages to screenshot.