{"id":13597437,"url":"https://github.com/sonnenkern/quip-export","last_synced_at":"2025-04-10T01:30:49.579Z","repository":{"id":38956090,"uuid":"216050621","full_name":"sonnenkern/quip-export","owner":"sonnenkern","description":"Export all folders and documents from Quip","archived":false,"fork":false,"pushed_at":"2023-09-27T07:15:04.000Z","size":842,"stargazers_count":108,"open_issues_count":15,"forks_count":20,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-03T15:23:29.445Z","etag":null,"topics":["503","annotations","api","automation","backup","chat","comments","conversation","docx","docx-export","embedded-images","export","folders","html-export","office","quip","quip-api","quip-export","xlsx","zero-configuration"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sonnenkern.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-10-18T15:08:32.000Z","updated_at":"2024-04-03T05:50:00.000Z","dependencies_parsed_at":"2024-01-14T04:41:21.197Z","dependency_job_id":"77dfa9fb-da88-49b5-9dec-00a0e443fd93","html_url":"https://github.com/sonnenkern/quip-export","commit_stats":{"total_commits":174,"total_committers":4,"mean_commits":43.5,"dds":"0.017241379310344862","last_synced_commit":"8b9a9b6121330881d9291851215dfc850d28ee32"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonnenkern%2Fquip-export","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonnenkern%2Fquip-export/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonnenkern%2Fquip-export/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonnenkern%2Fquip-export/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sonnenkern","download_url":"https://codeload.github.com/sonnenkern/quip-export/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248140236,"owners_count":21054267,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["503","annotations","api","automation","backup","chat","comments","conversation","docx","docx-export","embedded-images","export","folders","html-export","office","quip","quip-api","quip-export","xlsx","zero-configuration"],"created_at":"2024-08-01T17:00:32.963Z","updated_at":"2025-04-10T01:30:44.559Z","avatar_url":"https://github.com/sonnenkern.png","language":"JavaScript","funding_links":[],"categories":["automation"],"sub_categories":[],"readme":"# Quip-Export\nComprehensive full automated export (backup) tool for [Quip](https://quip.com/).\n\nQuip-Export uses official [Quip Automation API](https://quip.com/dev/automation/documentation) and exports all documents and folders from an Quip-Account. \n\nFeatures:\n\n* Export in HTML format with original Quip styling\n* Export in MS Office format: .docx for documents, .xlsx for spresdsheets _(--docx)_ \n* Embedded CSS for HTML-export _(--embedded-styles)_\n* Embedded images for HTML-export _(--embedded-images)_\n* Export of comments and conversations for HTML-export _(--comments)_\n* Export of specific folders only _(--folders)_ \n* Export of referenced files in documents\n* Resolving of references between folders and documents to relative paths\n\nSlides are not supported (due to poor quality of generated PDFs). Export in PDF are not supported (due to poor quality of generated PDFs).\n\nDespite Quip-Export is designed as a standalone tool for Node.js environment, it could be also used as Quip export library for any kind of JavaScript applications. In that case, the Quip-Export project is a good usage example.\n \nQuip-Export perfectly works on Windows, Mac OS and Linux/Unix in Node.js or in pure browser environment.  \n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/sonnenkern/quip-export/master/public/example-anim.gif\"\u003e\n\u003c/p\u003e\n\n## Online web app and demo\nFull featured web app using Quip-Export npm package with demo mode is available on [www.quip-export.com](https://www.quip-export.com)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/sonnenkern/quip-export/master/public/demo.gif\"\u003e\n\u003c/p\u003e\n\n## Install and usage\nAs mentioned before, Quip-Export tool needs Node.js (version 10.16 or higher) environment.\nNode.js version check:\n```\nnode -v\n```\nIf Node.js is not installed or the version is lower than 10.16, please follow install/update instructions on [Node.js website](https://nodejs.org/en/).\n\n### Use without installing locally\n```\nnpx quip-export [options]\n```\nAdvantage: you always run the latest version.\n\n### Install and usage as global npm package\nInstall:\n```\nnpm install -g quip-export\n```\n\nUsage example:\n```\nquip-export [options]\n```\n\n### Install and usage as a GitHUb project\nInstall:\n```\ngit clone https://github.com/sonnenkern/quip-export.git\n```\n\nInstall project dependencies:\n```\ncd quip-export\nnpm install\n```\n\nUsage example from project folder:\n```\nnode quip-export [options]\n```\n\n### Install as an npm dependency in a project\nInstall:\n```\nnpm install quip-export\n```\n\n## Options\n```\n  -h, --help                 Usage guide.\n  -v, --version              Print version info\n  -t, --token \"string\"       Quip Access Token.\n  -d, --destination \"string\" Destination folder for export files\n  -z, --zip                  Zip export files\n  --embedded-styles          Embedded in each document stylesheet\n  --embedded-images          Embedded images\n  --docx                     Exports documents in MS-Office format (*.docx , *.xlsx)\n  --comments                 Includes comments (messages) for the documents\n  --folders \"string\"         Comma-separated folder's IDs to export\n  --debug                    Extended logging\n```\n\nTo generate a personal access token, visit the page: [https://quip.com/dev/token](https://quip.com/dev/token)\n\nBe aware, the options --comments, --embedded-images, --embedded-styles don't work together with export in MS-Office format (--docx) and will be ignored.\n\nThe 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\".\n\n## Usage examples\nExport to folder c:\\temp\n```\nquip-export -t \"JHHHK222333444LLL1=\" -d c:\\temp\n```\nExport to current folder as destination\n```\nquip-export -t \"JHHHK222333444LLL1=\"\n```\nExport in Zip-file with current folder as destination\n```\nquip-export -t \"JHHHK222333444LLL1=\" -z\n```\n\n## Logging\nThe export errors are written to file export.log in the destination folder.\n\n## Troubleshooting\nQuip-Export is strongly depending on the public [Quip Automation API](https://quip.com/dev/automation/documentation).\nIt is possible that some problems will occur if Quip Automation API is changed. Then Quip-Export adjustment is necessary.\n\nIn this case or other questions, please feel free to contact [info@quip-export.com](info@quip-export.com).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsonnenkern%2Fquip-export","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsonnenkern%2Fquip-export","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsonnenkern%2Fquip-export/lists"}