figma file info

Show information of the Figma file

Security

watermint toolbox stores credentials into the file system. That is located at below path:

Please do not share those files to anyone including Dropbox support. You can delete those files after use if you want to remove it. If you want to make sure removal of credentials, revoke application access from setting or the admin console.

Please see below help article for more detail:

• Figma: https://help.figma.com/hc/

Auth scopes

Authorization

For the first run, tbx will ask you an authentication with your Figma account. Press Enter to launch the browser. The service then performs the authorization and the application receives the results. You can close the browser window when you see the authentication success message.

watermint toolbox xx.x.xxx
==========================

© 2016-2025 Takayuki Okazaki
Licensed under open source licenses. Use the `license` command for more detail.

Opening the authorization URL:
https://www.figma.com/oauth?client_id=xxxxxxxxxxxxxxxxxxx&redirect_uri=http%3A%2F%2Flocalhost%3A7800%2Fconnect%2Fauth&response_type=code&scope=file_read&state=xxxxxxxx

Installation

Please download the pre-compiled binary from Latest Release. If you are using Windows, please download the zip file like tbx-xx.x.xxx-win.zip. Then, extract the archive and place tbx.exe on the Desktop folder. The watermint toolbox can run from any path in the system if allowed by the system. But the instruction samples are using the Desktop folder. Please replace the path if you placed the binary other than the Desktop folder.

Usage

This document uses the Desktop folder for command example.

Run

Windows:

cd $HOME\Desktop
.\tbx.exe figma file info -key FILE_KEY

macOS, Linux:

$HOME/Desktop/tbx figma file info -key FILE_KEY

Note for macOS Catalina 10.15 or above: macOS verifies Developer identity. Currently, tbx is not ready for it. Please select “Cancel” on the first dialogue. Then please proceed “System Preference”, then open “Security & Privacy”, select “General” tab. You may find the message like:

“tbx” was blocked from use because it is not from an identified developer.

And you may find the button “Allow Anyway”. Please hit the button with your risk. At second run, please hit button “Open” on the dialogue.

Options:

-all-nodes

Include all node information. Default: false

-key

File key

-peer

Account alias. Default: default

Common options:

-auth-database

Custom path to auth database (default: $HOME/.toolbox/secrets/secrets.db)

-auto-open

Auto open URL or artifact folder. Default: false

-bandwidth-kb

Bandwidth limit in K bytes per sec for upload/download content. 0 for unlimited. Default: 0

-budget-memory

Memory budget (limits some feature to reduce memory footprint). Options: low, normal. Default: normal

-budget-storage

Storage budget (limits logs or some feature to reduce storage usage). Options: low, normal, unlimited. Default: normal

-concurrency

Maximum concurrency for running operation. Default: Number of processors

-debug

Enable debug mode. Default: false

-experiment

Enable experimental feature(s).

-extra

Extra parameter file path

-lang

Display language. Options: auto, en, ja. Default: auto

-output

Output format (none/text/markdown/json). Options: text, markdown, json, none. Default: text

-output-filter

Output filter query (jq syntax). The output of the report is filtered using jq syntax. This option is only applied when the report is output as JSON.

-proxy

HTTP/HTTPS proxy (hostname:port). Please specify DIRECT if you want to skip setting proxy.

-quiet

Suppress non-error messages, and make output readable by a machine (JSON format). Default: false

-retain-job-data

Job data retain policy. Options: default, on_error, none. Default: default

-secure

Do not store tokens into a file. Default: false

-skip-logging

Skip logging in the local storage. Default: false

-verbose

Show current operations for more detail.. Default: false

-workspace

Workspace path

Results

Report file path will be displayed last line of the command line output. If you missed the command line output, please see path below. [job-id] will be the date/time of the run. Please see the latest job-id.

Report: document

Figma Document The command will generate a report in three different formats. document.csv, document.json, and document.xlsx.

If you run with -budget-memory low option, the command will generate only JSON format report.

In case of a report becomes large, a report in .xlsx format will be split into several chunks like follows; document_0000.xlsx, document_0001.xlsx, document_0002.xlsx, …

Report: node

Node of the Figma document The command will generate a report in three different formats. node.csv, node.json, and node.xlsx.

If you run with -budget-memory low option, the command will generate only JSON format report.

In case of a report becomes large, a report in .xlsx format will be split into several chunks like follows; node_0000.xlsx, node_0001.xlsx, node_0002.xlsx, …