Duc-Tam Nguyen
e6afa91e09
kage renders every page in headless Chrome, snapshots the final DOM, strips all JavaScript, and localises CSS, images, and fonts so a site can be browsed offline as a plain folder of files. The engine is split into small packages: urlx deterministic URL to local-path mapping and scope rules sanitize remove scripts, on* handlers, and javascript: URLs asset rewrite HTML and CSS references, download assets browser headless Chrome pool over the DevTools protocol robots robots.txt matcher clone the orchestrator: a polite resumable breadth-first crawl The cli package wires a cobra and fang command surface with two commands, clone and serve. Every pure package has table tests; the browser and clone packages add Chrome-driven end-to-end tests that skip when no browser is present or under -short. CI runs gofmt, vet, build, race tests, golangci-lint, govulncheck, and a tidy check on Linux and macOS. A goreleaser config fans one tag out to archives, deb/rpm/apk, a Chromium-bundled GHCR image, and the package managers. A tago docs site builds to Pages and Cloudflare.
42 lines
2.2 KiB
Markdown
42 lines
2.2 KiB
Markdown
---
|
|
title: "kage"
|
|
description: "kage (影, shadow) clones any website into a self-contained folder you can browse offline, with all the JavaScript stripped out. Render in headless Chrome, remove every script, localise the CSS, images, and fonts, from one pure-Go binary."
|
|
heroTitle: "A website, frozen as a shadow"
|
|
heroLead: "kage renders every page in headless Chrome, snapshots the final DOM, removes every script and event handler, and downloads and rewrites the CSS, images, and fonts. The result looks like the live site but runs no code: a plain folder of .html files you can open straight from disk."
|
|
heroPrimaryURL: "/getting-started/quick-start/"
|
|
heroPrimaryText: "Get started"
|
|
---
|
|
|
|
Saving a page with "Save As" gives you a copy that still phones home, still runs
|
|
analytics, and often renders blank because the markup is built by JavaScript at
|
|
runtime. kage (影, "shadow") takes the opposite approach: it drives a real
|
|
browser, captures the page the way a human would have seen it, then makes it
|
|
inert.
|
|
|
|
```bash
|
|
kage clone example.com
|
|
kage serve kage-out/example.com
|
|
```
|
|
|
|
## What it does
|
|
|
|
- **Renders first, saves second.** Each page goes through real headless Chrome,
|
|
so a page whose content is assembled by JavaScript is captured fully, not as
|
|
an empty shell.
|
|
- **Strips every script.** Once the DOM is captured, kage removes all `<script>`
|
|
tags, every `on*` event handler, and any `javascript:` URL. The saved page
|
|
makes no network calls and runs no code.
|
|
- **Keeps the layout.** Stylesheets, images, fonts, and media are downloaded and
|
|
rewritten to relative local paths, so the offline copy looks like the original.
|
|
- **Stays browsable.** In-scope links are rewritten to point at the other saved
|
|
pages, so you can click around the mirror exactly as you would the live site.
|
|
|
|
## Where to go next
|
|
|
|
- New here? Start with the [introduction](/getting-started/introduction/), then
|
|
the [quick start](/getting-started/quick-start/).
|
|
- Want to install it? See [installation](/getting-started/installation/).
|
|
- Looking for a specific task? The [guides](/guides/) cover scoping a crawl,
|
|
serving a mirror, and resuming an interrupted run.
|
|
- Need every flag? The [CLI reference](/reference/cli/) is the full surface.
|