monolith README

The project's README from github.com/Y2Z/monolith. As one markdown file: README.md.

monolith build status on GNU/Linux monolith build status on macOS monolith build status on Windows Monolith Actor on Apify

 _____    _____________   __________     ___________________    ___
|     \  /             \ |          |   |                   |  |   |
|      \/       __      \|    __    |   |    ___     ___    |__|   |
|              |  |          |  |   |   |   |   |   |   |          |
|   |\    /|   |__|          |__|   |___|   |   |   |   |    __    |
|   | \__/ |          |\                    |   |   |   |   |  |   |
|___|      |__________| \___________________|   |___|   |___|  |___|

A data hoarder’s dream come true: bundle any web page into a single HTML file. You can finally replace that gazillion of open tabs with a gazillion of .html files stored somewhere on your precious little drive.

Unlike the conventional “Save page as”, monolith not only saves the target document, it embeds CSS, image, and JavaScript assets all at once, producing a single HTML5 document that is a joy to store and share.

If compared to saving websites with wget -mpk, this tool embeds all assets as data URLs and therefore lets browsers render the saved page exactly the way it was on the Internet, even when no network connection is available.


Installation

Using Cargo (cross-platform)

cargo install monolith

Via Homebrew (macOS and GNU/Linux)

brew install monolith

Via Chocolatey (Windows)

choco install monolith

Via Scoop (Windows)

scoop install main/monolith

Via Winget (Windows)

winget install --id=Y2Z.Monolith -e

Via MacPorts (macOS)

sudo port install monolith

Using Snapcraft (GNU/Linux)

snap install monolith

Using Guix (GNU/Linux)

guix install monolith

Using NixPkgs

nix-env -iA nixpkgs.monolith

Using Flox

flox install monolith

Using Pacman (Arch Linux)

pacman -S monolith

Using aports (Alpine Linux)

apk add monolith

Using XBPS Package Manager (Void Linux)

xbps-install -S monolith

Using FreeBSD packages (FreeBSD)

pkg install monolith

Using FreeBSD ports (FreeBSD)

cd /usr/ports/www/monolith/
make install clean

Using pkgsrc (NetBSD, OpenBSD, Haiku, etc)

cd /usr/pkgsrc/www/monolith
make install clean

Using containers

docker build -t y2z/monolith .
sudo install -b dist/run-in-container.sh /usr/local/bin/monolith

From source

Dependencies: libssl, cargo

Install cargo (GNU/Linux) Check if cargo is installed
cargo -v

If cargo is not already installed, install and add it to your existing $PATH (paraphrasing the official installation instructions):

curl https://sh.rustup.rs -sSf | sh
. "$HOME/.cargo/env"

Proceed with installing from source:

git clone https://github.com/Y2Z/monolith.git
cd monolith
make install

Using pre-built binaries (Windows, ARM-based devices, etc)

Every release contains pre-built binaries for Windows, GNU/Linux, as well as platforms with non-standard CPU architecture.


Usage

monolith https://lyrics.github.io/db/P/Portishead/Dummy/Roads/ -o %title%.%timestamp%.html
cat some-site-page.html | monolith -aIiFfcMv -b https://some.site/ - > some-site-page-with-assets.html

Options


Whitelisting and blacklisting domains

Options -d and -B provide control over what domains can be used to retrieve assets from, e.g.:

monolith -I -d example.com -d www.example.com https://example.com -o example-only.html
monolith -I -B -d .googleusercontent.com -d googleanalytics.com -d .google.com https://example.com -o example-no-ads.html

Dynamic content

Monolith doesn't feature a JavaScript engine, hence websites that retrieve and display data after initial load may require usage of additional tools.

For example, Chromium (Chrome) can be used to act as a pre-processor for such pages:

chromium --headless --window-size=1920,1080 --run-all-compositor-stages-before-draw --virtual-time-budget=9000 --incognito --dump-dom https://github.com | monolith - -I -b https://github.com -o github.html

Authentication

monolith https://username:[email protected] -o example-basic-auth.html

Proxies

Please set https_proxy, http_proxy, and no_proxy environment variables.


Apify Actor Usage

Run Monolith Actor on Apify

You can run Monolith in the cloud without installation using the Monolith Actor on Apify free of charge.

echo '{"urls": ["https://news.ycombinator.com/"]}' | apify call -so snshn/monolith
[{
  "url": "https://news.ycombinator.com/",
  "status": "0",
  "kvsUrl": "https://api.apify.com/v2/key-value-stores/of9xNgvpon4elPLbc/records/https___news.ycombinator.com_"
}]

Read more about the Monolith Actor, including how to use it via the Apify UI, API and CLI without installation.


Contributing

Please open an issue if something is wrong, that helps make this project better.


License

To the extent possible under law, the author(s) have dedicated all copyright related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.

monolith (Y2Z/monolith)

archive
Searching Database…

15.5K ·GitHub
What is this?Monolith bundles any web page into a single, self-contained HTML5 file by embedding its CSS, images, and JavaScript as data URLs, so the page renders exactly as it did online even without a network connection.
Is this a CLI tool, a GUI app, or a library?It is built as a Rust command-line tool and library; the README documents CLI usage with flags, and the GitHub description also lists it as usable as a library, though no GUI workflow is described in the README.
How do I install and run monolith?You can install it via Cargo, Homebrew, Chocolatey, Scoop, Winget, MacPorts, Snapcraft, Guix, NixPkgs, Pacman, or several other OS package managers, build it from source, or just grab a pre-built binary from the releases.
Do I need anything installed before building it from source?Building from source requires libssl and Cargo; if you just want a binary, pre-built releases for Windows, Linux, and ARM-based devices need nothing extra.
Does it capture pages that load content dynamically with JavaScript?No, monolith has no JavaScript engine, so sites that fetch and render data after the initial page load may need a pre-processing step with a real browser like Chromium before saving.
Which operating systems does it run on?It runs on Windows, macOS, Linux and several BSD variants, with pre-built binaries also provided for ARM-based devices.
How is this different from the browser's 'Save page as' feature?Browser save creates a page plus a folder of separate asset files, while monolith embeds CSS, images, and JavaScript directly as data URLs into one single HTML5 file, making it easier to store and share.
How does it compare to using wget -mpk to mirror a page?Unlike wget, which saves assets as separate files, monolith inlines everything as data URLs so the saved page renders exactly like the original even with no internet connection.
Can I control which domains assets are fetched from?Yes, the -d flag whitelists specific domains for asset retrieval and the -B flag blacklists domains you want to exclude.
Can I save a page as MHTML instead of plain HTML?Yes, the -m flag outputs the result in MHTML format instead of a standard HTML5 file.
What are similar projects?hexyl, ttfx, miller, turbocrypt, just, pytube, eza, spotify-tui
Creator
Y2Z
Size
4.6 MB
Stars
15.5K
Age
9y
Commits · 90 Days