# abstract-backup

> Download a local backup of the Sketch files from all your Abstract projects

Latest version **0.0.3** (published 2019-08-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install abstract-backup
pnpm add abstract-backup
yarn add abstract-backup
bun add abstract-backup
```

Provides the command `abstract-backup`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2019-08-13 |
| First published | 2019-08-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Lim Yuan Qing |
| Maintainers | yuanqing |

## Links

- npm: https://www.npmjs.com/package/abstract-backup
- Repository: https://github.com/yuanqing/abstract-backup
- Homepage: https://github.com/yuanqing/abstract-backup#readme
- Issues: https://github.com/yuanqing/abstract-backup/issues
- npm.io page: https://npm.io/package/abstract-backup

## Dependencies (7)

- [ora](https://npm.io/package/ora.md) ^3.4.0
- [sade](https://npm.io/package/sade.md) ^1.6.1
- [limiter](https://npm.io/package/limiter.md) ^1.1.4
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [abstract-sdk](https://npm.io/package/abstract-sdk.md) ^1.9.0
- [p-each-series](https://npm.io/package/p-each-series.md) ^2.1.0
- [sanitize-filename](https://npm.io/package/sanitize-filename.md) ^1.6.2

## Recent versions

- 0.0.3 (latest) — 2019-08-13
- 0.0.2 — 2019-08-13
- 0.0.1 — 2019-08-12

## README

# abstract-backup [![npm Version](https://img.shields.io/npm/v/abstract-backup)](https://www.npmjs.org/package/abstract-backup) [![Build Status](https://img.shields.io/travis/yuanqing/abstract-backup.svg)](https://travis-ci.org/yuanqing/abstract-backup)

> Download a local backup of the Sketch files from all your [Abstract](https://www.abstract.com/) projects

## Usage

_Requires [Node.js](https://nodejs.org/)._

1. Ensure that:
    - The [Abstract desktop app](https://www.abstract.com/help/getting-started/#2-download-the-macos-app) is installed
    - You are logged in
    - All projects are [set to sync to your computer](https://www.abstract.com/help/projects/sync-project/#how-to-sync-a-project-to-your-computer)

2. Create an [access token for the Abstract API.](https://app.goabstract.com/account/tokens)

3. Where `<token>` is your access token, do:

    ```sh
    $ npx abstract-backup <token>
    ```

    Alternatively:

    ```sh
    $ export ABSTRACT_TOKEN=<token>
    $ npx abstract-backup
    ```

4. `abstract-backup` will download and write all your Sketch files, organised by project, to an `./abstract-backup` folder. Change this via the `--directory` flag:

    ```sh
    $ npx abstract-backup --directory sketch
    ```

## Installation

```sh
$ npm install --global abstract-backup
```

## License

[MIT](LICENSE.md)

---
_Source: https://npm.io/package/abstract-backup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
