Show information of the Figma file
watermint toolbox
stores credentials into the file system. That is located at below path:
OS | Path |
---|---|
Windows | %HOMEPATH%\.toolbox\secrets (e.g. C:\Users\bob.toolbox\secrets) |
macOS | $HOME/.toolbox/secrets (e.g. /Users/bob/.toolbox/secrets) |
Linux | $HOME/.toolbox/secrets (e.g. /home/bob/.toolbox/secrets) |
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:
Description |
---|
Figma: Permission to access your Figma files on your behalf. |
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
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.
This document uses the Desktop folder for command example.
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.
DIRECT
if you want to skip setting proxy.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.
OS | Path pattern | Example |
---|---|---|
Windows | %HOMEPATH%\.toolbox\jobs\[job-id]\reports |
C:\Users\bob.toolbox\jobs\20190909-115959.597\reports |
macOS | $HOME/.toolbox/jobs/[job-id]/reports |
/Users/bob/.toolbox/jobs/20190909-115959.597/reports |
Linux | $HOME/.toolbox/jobs/[job-id]/reports |
/home/bob/.toolbox/jobs/20190909-115959.597/reports |
Figma Document
The command will generate a report in three different formats. document.csv
, document.json
, and document.xlsx
.
Column | Description |
---|---|
name | Name of the document |
role | Your role |
lastModified | Last modified timestamp |
editorType | Figma editor type (figma/figjam) |
version | Version of the document |
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
, …
Node of the Figma document
The command will generate a report in three different formats. node.csv
, node.json
, and node.xlsx
.
Column | Description |
---|---|
id | Node ID |
type | Type of the node |
name | Name of the node |
absoluteBoundingBox | Bounding box of the node in absolute space coordinates |
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
, …