Giter VIP home page Giter VIP logo

whimsical-exporter's Introduction

whimsical-exporter

CLI tool to export your Whimsical boards recursively as SVG, PNG, or PDF from a starting folder URL.

Features

  • Exports folders and boards recursively, keeping the same folder structure.
  • Allows selecting the exporting formats:
    • PNG at 2x zoom (static image, shapes cannot be edited)
    • PDF (landscape, shapes can be zoomed in)
    • SVG (shapes can be zoomed in and edited)
  • If the process fails, you can run the same command again and it will skip existing files.
  • Automatically skips empty boards.
  • All code is run locally in your machine using a headless Chromium browser.
  • Your login credentials are never stored or shared.

Requirements

Usage

You can just run the latest version from the terminal, without installing it locally:

npx whimsical-exporter

Or clone the repo and install the dependencies with npm install, then run it with npm start.

The interactive tool will ask you for your email, password, the URL you want to start exporting from, and the image formats you prefer and will save the files with the same folder structure in a downloads folder on your working directory.

If you plan to run this tool several times, you can also pass these options as environment variables:

EMAIL='[email protected]' PASSWORD='your_password' FOLDER_URL='https://whimsical.com/your-folder-name' FILE_TYPES='svg,png,pdf' npx whimsical-exporter

If you would like to debug the tool, you can make the browser automation visible and open the dev tools panel with the DEBUG environment variable. Please note that you may get print dialogs that will steal your focus when exporting to PDF on this mode:

DEBUG=true npx whimsical-exporter

License

© Rodrigo Fernández, MIT license.

whimsical-exporter's People

Contributors

fdezromero avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.