AGPL-3.0 License
SingleFile Companion is a program that runs outside the browser. It can:
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 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
install.sh
executable (Linux/Unix/BSD etc.).chmod +x install.sh
install
./install.sh
(Linux/Unix/BSD etc.)
install.bat
(Windows)
Destination > save with SingleFile Companion
orAuto-save > save the page with SingleFile Companion
in SingleFileThe options.json
file allows configuring SingleFile Companion. Here are the
entries you can edit:
savePath
: path where to save files (default: SingleFile/companion
path)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 toolsfalse
)