|
|
@@ -1,20 +1,20 @@
|
|
|
# SingleFile Companion
|
|
|
-SingleFile Companion is a program that runs outside the browser. It:
|
|
|
- - makes the saving process more transparent when the auto-save is active in SingleFile,
|
|
|
- - allows you to save pages in another directory than the download directory,
|
|
|
- - saves pages in an anonymous session in a separate browser.
|
|
|
+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 uses the [Native Messaging API](https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/Native_messaging) to communicate with SingleFile.
|
|
|
|
|
|
## Install
|
|
|
|
|
|
- - Install [SingleFile CLI](https://github.com/gildas-lormeau/SingleFile/tree/master/cli)
|
|
|
+ - Install [SingleFile CLI](https://github.com/gildas-lormeau/SingleFile/tree/master/cli) with NPM
|
|
|
|
|
|
- - In the `companion` folder of SingleFile, go into the subfolder corresponding to your OS and your browser. For example, if you use Chome on Windows:
|
|
|
+ - In the `companion` folder of SingleFile, go into the subfolder corresponding to your OS and your browser. For example, if you use Chome on Linux:
|
|
|
|
|
|
`cd companion`
|
|
|
|
|
|
-`cd win`
|
|
|
+`cd linux`
|
|
|
|
|
|
`cd chrome`
|
|
|
|
|
|
@@ -39,7 +39,3 @@ These options are also available when the option `Auto-save > save the page with
|
|
|
- `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`)
|
|
|
-
|
|
|
-## Notes
|
|
|
-
|
|
|
- - Only the Chrome version of SingleFile allows you to use SingleFile Companion at the moment. This feature will be available in Firefox when this bug is fixed: https://bugzilla.mozilla.org/show_bug.cgi?id=1630415. Although, you can use SingleFile Companion with Firefox by installing SingleFile manually, see https://github.com/gildas-lormeau/SingleFile#install.
|
Gildas