Poliage

Quick Start

Let's capture your first visual documentation in under 5 minutes.

Step 1: Launch Chrome in Debug Mode

Poliage needs to control Chrome to record interactions. Launch a pre-configured instance:

poliage chrome

You must fully quit all Chrome instances before running this command.

Navigate this Chrome window to the URL you want to capture (e.g., http://localhost:3000).

Step 2: Start Recording

You can start recording from the Studio UI or via the terminal:

poliage record "My First Scenario"

The CLI connects to your active Chrome tab and begins logging your actions.

Step 3: Interact and Capture

As you interact with the page, Poliage logs actions using robust selectors (data-testid, role, aria-label).

Controls:

KeyAction
InteractClick and type normally—steps are automatically recorded
Press COpens the capture menu for screenshots or video clips
Press QSaves the scenario to docsync.config.json

Capture Options

When you press C:

  • Single-Step Screenshot: Takes a PNG of the current state (Full Page or Specific Element)
  • Multi-Step Clip: Records a short video (MP4) of subsequent actions

Step 4: Run the Scenario

Once recorded, re-run the scenario headlessly to generate fresh assets:

poliage run --scenarios "my-first-scenario"

Step 5: View Your Assets

Open the Studio to see your captured assets:

poliage studio

Or use the shortcut:

poliage ui

Navigate to the Assets tab to see your generated screenshots and videos.

What's Next?