• Stars
    star
    116
  • Rank 303,894 (Top 6 %)
  • Language
    JavaScript
  • License
    GNU Affero Genera...
  • Created over 2 years ago
  • Updated 10 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

SingleFile Companion

SingleFile Companion is a program that runs outside the browser. It can:

  • make the saving process more transparent when the auto-save is active in SingleFile,
  • auto-save pages in an anonymous session in a separate browser,
  • save pages in another directory than the download directory.

It is recommended to use SingleFile Companion Lite if you only want to save pages in a directory other than the download directory.

It uses the Native Messaging API to communicate with SingleFile.

Install

  • Install Node.js

  • Install jq, the JSON processor

  • Download the SingleFile Companion project zip file and unzip it somewhere on your disk.

  • Run npm install in the root folder where you unzipped SingleFile Companion.

  • Go into the subfolder corresponding to your OS and your browser. For example, if you use Chome on Linux:

cd companion

cd linux

cd chrome

  • Make install.sh executable (Linux/Unix/BSD etc.).

chmod +x install.sh

  • Run install

./install.sh (Linux/Unix/BSD etc.)

install.bat (Windows)

  • Enable the option Destination > save with SingleFile Companion or Auto-save > save the page with SingleFile Companion in SingleFile

Options

The options.json file allows configuring SingleFile Companion. Here are the entries you can edit:

  • savePath: path where to save files (default: SingleFile/companion path) These options are also available when the option Auto-save > save the page with SingleFile Companion is enabled:
  • backEnd: backend used to save the page (default: "puppeteer")
  • errorFile: path of the file where errors are stored (default: undefined)
  • browserHeadless: whether the browser is launched in headless mode (default: true)
  • browserDebug: whether the browser is launched with the developer tools opened (default: false)

More Repositories

1

SingleFile

Web Extension for saving a faithful copy of a complete web page in a single HTML file
JavaScript
14,584
star
2

zip.js

JavaScript library to zip and unzip files supporting multi-core compression, compression streams, zip64, split files and encryption.
JavaScript
3,360
star
3

SingleFileZ

Web Extension to save a faithful copy of an entire web page in a self-extracting ZIP file
JavaScript
1,813
star
4

JSONVue

Fork of JSONView for Chromium-based browsers
JavaScript
1,586
star
5

single-file-cli

CLI tool for saving a faithful copy of a complete web page in a single HTML file (based on SingleFile)
JavaScript
571
star
6

SingleFile-MV3

SingleFile version compatible with Manifest V3. The future, right now!
JavaScript
319
star
7

Scrapbook-for-SingleFile

PageArchiver (previously called "Scrapbook for SingleFile") is a Chrome extension that helps to archive pages for offline reading
JavaScript
87
star
8

single-file-companion-lite

SingleFile Companion Lite
TypeScript
66
star
9

single-filez-cli

JavaScript
37
star
10

zip-manager

Progressive Web App for creating, reading, and editing zip files
JavaScript
37
star
11

single-file-export-chat

Extension to export MS Teams chats
JavaScript
33
star
12

PageEdit

WYSIWYG HTML editor chrome extension
JavaScript
29
star
13

SingleFile-Safari-Extension

Source code of SingleFile for Safari
JavaScript
28
star
14

LazyLoadify

Web Extension to force the lazy loading of non-displayed resources (i.e. image, frame, video and audio contents)
JavaScript
28
star
15

PrettyPrint

A chrome extension to pretty print JavaScript and CSS
JavaScript
24
star
16

single-file-core

JavaScript
23
star
17

BugMeNot-Lite

Fill automatically login and password fields when a registration form is displayed using bugmenot accounts.
JavaScript
14
star
18

Polyglot-HTML-ZIP-PNG

Learn how to create HTML/ZIP/PNG polyglot files in JavaScript!
JavaScript
14
star
19

SingleFile-MAFF2HTML

Convert MAFF to HTML with SingleFile
JavaScript
13
star
20

ZipTabs

Chrome extension to archive opened tabs in a zip file
JavaScript
12
star
21

yabson

YaBSON is a library allowing schemaless binary-encoded parsing/serialization of JavaScript data with a generator-based implementation
JavaScript
12
star
22

simple-cdp

Lightweight JavaScript library to interact with Chromium-based browsers via the Chrome DevTools Protocol
JavaScript
10
star
23

SingleFile-Archives

Pages saved with SingleFile
HTML
7
star
24

SingleFile-tools

JavaScript
5
star
25

single-filez-core

JavaScript
5
star
26

Chrome-extensions-presentation

Slides et exemple d'extension de la présentation donnée au BreizhCamp 2011 (Slides and sample extension from presentation I gave at BreizhCamp 2011) - http://www.breizhcamp.org/
JavaScript
5
star
27

CKEditor-extension-demo

Simple demo of CKEditor integration in a chrome extension
JavaScript
4
star
28

SingleFile-Demos

Demos of SingleFile and SingleFileZ
4
star
29

gildas-lormeau.github.io

https://gildas-lormeau.github.io/
HTML
2
star
30

misc-demos

2
star