Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexwlchan/safari-webarchiver
Save web pages as Safari webarchive files from the command line
https://github.com/alexwlchan/safari-webarchiver
safari web-scraping webarchives webkit wkwebview
Last synced: 7 days ago
JSON representation
Save web pages as Safari webarchive files from the command line
- Host: GitHub
- URL: https://github.com/alexwlchan/safari-webarchiver
- Owner: alexwlchan
- License: mit
- Created: 2024-05-16T20:08:55.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-01-23T23:27:11.000Z (22 days ago)
- Last Synced: 2025-01-24T00:23:42.811Z (22 days ago)
- Topics: safari, web-scraping, webarchives, webkit, wkwebview
- Language: Python
- Homepage:
- Size: 51.8 KB
- Stars: 133
- Watchers: 1
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# safari-webarchiver
This tool creates [Safari webarchive files](https://en.wikipedia.org/wiki/Webarchive) on the command line.
This gives you an offline archive of web pages, which can be stored and backed up independently of any cloud services.
```console
$ save_safari_webarchive "https://example.com" "example.webarchive"
```
These archives are the same as those created by the `File > Save As…` menu item, but now you can create them programatically and in bulk.
## How it works
It opens the given URL in a `WKWebView`, calls `createWebArchiveData` to create a webarchive file, and saves it to disk.
That's the core workflow, and then there's a bunch of error handling around that.
For a more detailed explanation of this code, see
## Installation
### Install from source
1. Install the Xcode Command Line Tools
2. Download the `save_safari_webarchive.swift` script from this repo
3. Compile the script into a binary:
```console
$ swiftc save_safari_webarchive.swift
```
4. Copy the compiled binary `save_safari_webarchive` to somewhere in your PATH.
### Install a compiled binary
1. Find the latest [GitHub release](https://github.com/alexwlchan/safari-webarchiver/releases)
2. Download the zip file which is appropriate for your system (Intel = `x86_64`, Apple Silion = `aarch64`)
3. Open the zip file, and add the `save_safari_webarchive` app to your PATH
The app is just a compiled version of the Swift script.
It isn't notarised, so when you run it, you may get a warning that this app is from an unidentified developer.
You can get around this by right-clicking the app icon in Finder, and choosing `Open` from the shortcut menu.
## Usage
Run the script passing two arguments: the URL you want to archive, and the path where you want to save the webarchive file.
For example, this command will save the URL to this GitHub repo to `safari-webarchiver.webarchive`:
```console
$ save_safari_webarchive "https://github.com/alexwlchan/safari-webarchiver" "safari-webarchiver.webarchive"
```
## Acknowledgements
This is partially inspired by [a similar script](https://github.com/newzealandpaul/webarchiver) written in 2008 by newzealandpaul.