Documentation

Install SugarStitch

Pick the quick global npm route if you mainly want the CLI, or clone the repository if you want the local UI and source code together.

On this page

Requirements

SugarStitch runs on Node.js and uses npm scripts for the local development flow.

Node.js 20 or newer is the safest baseline for the current TypeScript setup.
npm is used for installation and running scripts.
An internet connection is needed when you scrape live pattern pages.

Best fit: SugarStitch works best on traditional HTML pattern pages where the article content is already present in the fetched markup, rather than rendered by a JavaScript app after load.

Install with npm

This is the fastest path when you just want to run the scraper from your terminal.

1. Install the package globally

npm install -g @pinkpixel/sugarstitch

2. Run a quick scrape

sugarstitch --url "https://example.com/pattern"

3. Add a preset when the site structure is recognizable

sugarstitch --url "https://example.com/pattern" --preset wordpress

Preset tip: Start with generic for unknown sites, wordpress for blog-style posts, and woocommerce for product-style pattern pages.

Clone the repo

This path is best if you want the browser UI, local scripts, and source files in one place.

1. Clone and install dependencies

git clone https://github.com/pinkpixel-dev/sugarstitch.git
cd sugarstitch
npm install

2. Optional: build the CLI output

npm run build

3. Run the CLI from source

npm run scrape -- --url "https://example.com/pattern"

What the terminal flow looks like

CLI output showing the SugarStitch banner and scrape progress

The CLI prints the SugarStitch banner and progress messages while it fetches pages, downloads assets, and writes local files.

Run the local UI

If you prefer forms over flags, the local browser UI gives you the same scraping controls in a calmer, more visual workflow.

Start the server

npm run ui

Open the app

http://localhost:4177

Homepage

The homepage includes mode selection, output controls, presets, saved profiles, and advanced selector overrides.

In-progress state

While a preview or scrape is running, the UI swaps into a progress overlay so you know the run is active.