figma-export

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #go #android #nodejs #macos #java #windows #kubernetes #vue #awesome-list #security #open-source

(★ 151)

A CLI tool to bulk export Figma, FigJam, and Figma Slides files

파일 탐색기

최종 버전 다운로드 (.zip)

- auth.setup.ts
- download.spec.ts
- get-folder-files.js
- get-team-files.js
- lib.js
.gitignore
.nvmrc
eslint.config.mjs
LICENSE
package-lock.json
package.json
playwright.config.ts
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# figma-export

figma-export is a CLI tool for bulk exporting Figma, FigJam, and Figma Slides files to your local desktop in Figma's proprietary `.fig`/`.jam`/`.deck` format. figma-export supports downloading by team, project, and even drafts.

This tool leverages [Figma's REST API](https://www.figma.com/developers/api) and [Playwright](https://playwright.dev/) to automate discovering Figma files and downloading them.

> [!NOTE]
> If you are a complete beginner to the terminal and CLI tools, please refer to the [Complete beginner guide](https://github.com/alexchantastic/figma-export/wiki/Complete-beginner-guide) in the wiki.

## Table of contents

- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Commands](#commands)
- [Known issues](#known-issues)

## Requirements

- node (v24 LTS)
- npm (v11 LTS)

Other versions may work, but have not been officially tested.

You will also need a [Figma access token](https://www.figma.com/developers/api#authentication) with scope access to **folders:read** so that you can generate through your Figma user profile settings.

> [!NOTE]
> You must disable opening links in the Figma desktop app in order for downloads to work. See the [Figma docs](https://help.figma.com/hc/articles/360039824334-Open-links-in-the-desktop-app#h_01HW8HDP9DN3HTMQ65XQMXR88A) on how to disable this setting.

## Installation

1. Clone the repository or download the latest release
2. `cd` into the repository
3. Run `npm install`

## Usage

### Environment variables

Create a `.env` file at the root of the repository:

```sh
FIGMA_EMAIL="email@example.com"
FIGMA_PASSWORD="hunter2"
FIGMA_ACCESS_TOKEN="figd_abcdefghijklmnopqrstuvwxyz"
DOWNLOAD_PATH="/Users/anonymous/Downloads" # Absolute path where files will be downloaded to
WAIT_TIMEOUT=10000 # Time in ms to wait between downloads (defaults to 10000)
```

> [!CAUTION]
> Figma has started to implement anti-automation detection which may cause issues with using this tool. It is recommended that you do not set a lower `WAIT_TIMEOUT` than `10000`. To be on the safer side, you may want to increase it even further.

If you are using SSO to log in to Figma, you can either manually set a password (see [wiki](https://github.com/alexchantastic/figma-export/wiki/Manually-setting-a-Figma-password)) _or_ you can provide your Figma auth session cookie through `FIGMA_AUTH_COOKIE` in lieu of `FIGMA_EMAIL` and `FIGMA_PASSWORD`:

```sh
FIGMA_AUTH_COOKIE="my-auth-cookie-value"
FIGMA_ACCESS_TOKEN="figd_abcdefghijklmnopqrstuvwxyz"
DOWNLOAD_PATH="/Users/anonymous/Downloads"
WAIT_TIMEOUT=10000
```

The value for `FIGMA_AUTH_COOKIE` should be the value of the `__Host-figma.authn` cookie. Please refer to the [wiki](https://github.com/alexchantastic/figma-export/wiki/Getting-your-Figma-auth-session-cookie) on how to grab this value.

### Generating files.json

`files.json` determines which Figma files within your account will be downloaded.

> [!TIP]
> Drafts are just a hidden folder in Figma so you can absolutely download them with figma-export. Check out the [wiki](https://github.com/alexchantastic/figma-export/wiki/Downloading-draft-files) to learn about how to grab the drafts folder ID.

It is recommended that you use one of the built-in commands to generate `files.json`:

- `npm run get-team-files {team_ids ...}` - Gets all files for all folders (including subfolders) within given team IDs (space separated)
  - Example: `npm run get-team-files 12345 67890`
- `npm run get-folder-files {folder_ids ...}` - Gets all files for given folder IDs (space separated), traversing subfolders
  - Example: `npm run get-folder-files 12345 67890`

To find your Figma team ID, navigate to your [Figma home](https://www.figma.com/files/), right click your team in the left sidebar, and then click **Copy link**. The last segment of the URL that you copied will contain your team ID: `https://www.figma.com/files/team/1234567890`.

To find a folder ID, navigate to your team's home, right click the folder, and then click **Copy link**. The last segment of the URL that you copied will contain the folder ID: `https://www.figma.com/files/project/1234567890` or `https://www.figma.com/files/folder/1234567890`.

You are free to manually construct this file as long as it follows this structure:

```json
[
  {
    "name": String,
    "id": String,
    "team_id": String?,
    "files": [
      {
        "key": String,
        "name": String,
        "downloaded": Boolean?
      },
      ...
    ]
  },
  ...
]
```

This is a modified structure from the return value of [Figma's GET folder files](https://developers.figma.com/docs/rest-api/folders-endpoints/#get-folder-files-endpoint) endpoint.

#### Filtering files by date

You can filter files by their last modified date using the `-last-modified-before` and `-last-modified-after` flags.

- `-last-modified-before <date>`: Only download files that were last modified before the specified date.
- `-last-modified-after <date>`: Only download files that were last modified after the specified date.

Any date format supported by JavaScript's `Date.parse()` is accepted (such as `YYYY-MM-DD` or ISO 8601 strings).

**Examples:**

- Only get files modified after `2026-06-01`:
  ```sh
  npm run get-team-files -- 12345 67890 -last-modified-after 2026-06-01
  ```
- Get files modified between `2026-05-01` and `2026-06-01`:
  ```sh
  npm run get-folder-files -- 12345 -last-modified-after 2026-05-01 -last-modified-before 2026-06-01
  ```

### Starting the downloads

Once you have generated `files.json`, you can then run `npm run start` to start the downloads. The status of each download will be shown in the console.

Each file will be downloaded to your specified `DOWNLOAD_PATH` in a folder named with the folder's name and ID. Each file will be saved as the file's name and ID (key). The folder structure will look something like this:

```
Folder A (12345)/
├── File X (123).fig
└── File Y (456).fig
Folder B (67890)/
└── File Z (789).fig
```

If you ran `get-team-files`, your `files.json` will also have references to the team ID(s) so folders will be placed in a folder named after the team ID. In which case, the folder structure will look something like this:

```
1029384756/
├── Folder A (12345)/
│   ├── File X (123).fig
│   └── File Y (456).fig
└── Folder B (67890)/
    └── File Z (789).fig
5647382910/
└── Folder C (45678)/
    └── File W (012).fig
```

### Download tracking

Each successful file download will be tracked in `files.json` by adding a `"downloaded": true` property to the corresponding file object.

If a run is stopped or fails midway, running `npm run start` again will automatically resume downloading only the remaining pending files.

To bypass tracking and force-download all files from scratch (including those already downloaded), run:

```sh
npm run start:force
```

### Limiting downloads

You can limit the number of files downloaded in a single run using the `-limit` flag:

```sh
npm run start -- -limit 10
```

This will download only the first 10 pending (not yet downloaded) files and then stop. This is useful for testing your setup or working around Figma's anti-automation measures by downloading in smaller batches.

### Parallel downloads

Parallel downloads are disabled by default. To enable them, update the following properties in `playwright.config.ts`:

```ts
export default defineConfig({
  ...
  fullyParallel: true,
  workers: 3, // The maximum number of parallel downloads
  ...
});
```

> [!CAUTION]
> It is not advised to use parallel downloads as Figma has started to invoke anti-automation safe guards.

### Retrying failed downloads

If you encounter downloads that fail, you can attempt to re-run _only_ those failed downloads using the `npm run retry` command.

Note that downloads may fail due to any number of reasons, but typically it is due to reaching the Playwright timeout. You can increase this timeout by updating the `timeout` configuration in `playwright.config.ts`.

## Commands

The following commands are available via `npm run`:

| Command             | Description                                                    |
| ------------------- | -------------------------------------------------------------- |
| `get-team-files`    | Generates `files.json` from Figma team ID(s)                   |
| `get-folder-files`  | Generates `files.json` from Figma folder ID(s)                 |
| `start`             | Starts downloads                                               |
| `start:force`       | Starts downloads, forcing all files to be downloaded again     |
| `retry`             | Retries failed downloads from last run                         |
| `dry-run`           | Lists files that will be downloaded                            |
| `report`            | Shows an HTML report of the last run                           |

At any time, you can press `ctrl+c` to stop a command.

## Known issues

- Two-factor authentication is not supported (suggest temporarily disabling two-factor authentication)
- You must have editor access to a file in order to download it
- Some downloads may take a long time (large file size, slow internet connection, etc.) which can trigger the Playwright timeout and lead to a failed download (suggest increasing the `timeout` in `playwright.config.ts`)
- Figma will invoke anti-automation measures based off of how many files you download (suggest using a `WAIT_TIMEOUT` of at least `10000`)
- If you have the setting for opening links in the Figma desktop app enabled, downloads will not start (suggest [disabling the setting](https://help.figma.com/hc/articles/360039824334-Open-links-in-the-desktop-app#h_01HW8HDP9DN3HTMQ65XQMXR88A))

figma-export

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

figma-export

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README