Comprehensive full automated export (backup) tool for Quip.
Quip-Export uses official Quip Automation API and exports all documents and folders from an Quip-Account.
- Export in HTML format with original Quip styling
- Export in MS Office format: .docx for documents, .xlsx for spresdsheets (--docx)
- Embedded CSS for HTML-export (--embedded-styles)
- Embedded images for HTML-export (--embedded-images)
- Export of comments and conversations for HTML-export (--comments)
- Export of specific folders only (--folders)
- Export of referenced files in documents
- Resolving of references between folders and documents to relative paths
Slides are not supported (due to poor quality of generated PDFs). Export in PDF are not supported (due to poor quality of generated PDFs).
Quip-Export perfectly works on Windows, Mac OS and Linux/Unix in Node.js or in pure browser environment.
Online web app and demo
Full featured web app using Quip-Export npm package with demo mode is available on www.quip-export.com
Install and usage
As mentioned before, Quip-Export tool needs Node.js (version 10.16 or higher) environment. Node.js version check:
If Node.js is not installed or the version is lower than 10.16, please follow install/update instructions on Node.js website.
Use without installing locally
npx quip-export [options]
Advantage: you always run the latest version.
Install and usage as global npm package
npm install -g quip-export
Install and usage as a GitHUb project
git clone https://github.com/sonnenkern/quip-export.git
Install project dependencies:
cd quip-export npm install
Usage example from project folder:
node quip-export [options]
Install as an npm dependency in a project
npm install quip-export
-h, --help Usage guide. -v, --version Print version info -t, --token "string" Quip Access Token. -d, --destination "string" Destination folder for export files -z, --zip Zip export files --embedded-styles Embedded in each document stylesheet --embedded-images Embedded images --docx Exports documents in MS-Office format (*.docx , *.xlsx) --comments Includes comments (messages) for the documents --folders "string" Comma-separated folder's IDs to export --debug Extended logging
To generate a personal access token, visit the page: https://quip.com/dev/token
Be aware, the options --comments, --embedded-images, --embedded-styles don't work together with export in MS-Office format (--docx) and will be ignored.
The easiest way to get to know ID of Quip fodler is just to open the folder in Quip web application in browser and look at adress line. For example the adress "https://quip.com/bGG333444111" points to the folder with ID "bGG333444111".
Export to folder c:\temp
quip-export -t "JHHHK222333444LLL1=" -d c:\temp
Export to current folder as destination
quip-export -t "JHHHK222333444LLL1="
Export in Zip-file with current folder as destination
quip-export -t "JHHHK222333444LLL1=" -z
The export errors are written to file export.log in the destination folder.
Quip-Export is strongly depending on the public Quip Automation API. It is possible that some problems will occur if Quip Automation API is changed. Then Quip-Export adjustment is necessary.
In this case or other questions, please feel free to contact firstname.lastname@example.org.