CLI 使用说明
本页汇总当前 packages 中所有对外 CLI 的安装方式、主要命令与使用示例。目前包含 spec-ts 与 figma-toolkit 两个命令。
figma-toolkit
用于管理本地 Figma 配置，并直接调用 Figma 官方 REST API 读取文件、节点和图片资源。
查看 figma-toolkit 详细说明spec-ts
spec-ts 是 `@klaaay/spec-kit-ts` 暴露的命令。它负责把项目模板、命令目录和命令包内容写入具体项目目录。
安装
主要命令
init
初始化项目模板，并按 AI 助手写入对应命令与目录结构。
check
检查 Git、内置 AI 助手 CLI、VS Code 与 VS Code Insiders 是否可用。
pull-package
从命令包静态源拉取命令包内容，并写入当前项目模板目录。
支持的 AI 助手键名
以下键名可用于 --ai 参数。标记为“需要 CLI”的助手，需要先在本机安装对应命令行工具。
常用参数
init
--ai <agent>：必填，指定要启用的 AI 助手键名。--script <type>：脚本类型，支持sh和ps。--ignore-agent-tools：跳过对 AI 助手 CLI 的安装检查。--no-git：跳过 Git 仓库初始化。--here：在当前目录初始化，而不是创建新目录。--force：与--here配合时跳过覆盖确认。
pull-package
--registry <url>：命令包源地址。--ai <agent>：必填，指定要写入模板的 AI 助手。--script <type>：脚本类型，支持sh和ps。--project <path>：Specify 项目根目录，默认当前目录。--force：允许覆盖本地已存在的模板与命令文件。
figma-toolkit
figma-toolkit 是 `@klaaay/figma-toolkit-cli` 暴露的命令，负责保存本地配置并直接调用 Figma 官方 REST API。
安装
配置命令
set-token
保存 Figma Token 到本地配置文件。
set-base-url
保存 Figma API 服务地址。
list
查看当前配置，Token 会自动脱敏。
path
输出配置文件路径。
remove
删除某一项配置，支持 figmaToken、baseUrl。
默认配置文件路径为 ~/.figma-toolkit-cli/config.json。
Figma API 命令
figma file
读取文件信息，对应 Figma 官方 `GET /v1/files/{file_key}`。
figma nodes
读取节点信息，对应 `GET /v1/files/{file_key}/nodes`。
figma images
导出并下载图片资源到本地目录，对应 `GET /v1/images/{file_key}`。
figma image-fills
读取图片填充资源，对应 `GET /v1/files/{file_key}/images`。
输入规则
- 所有 Figma 子命令都支持直接传入
fileKey。 figma file、figma nodes、figma images、figma image-fills都支持直接传完整 Figma 链接。- 对
nodes和images，如果链接中带有node-id，CLI 会自动解析成ids。 - 如果链接里没有
node-id，而当前命令又需要节点 ID，则需要显式传入--ids。
配置优先级
- 命令行参数
--token、--base-url - 环境变量
FIGMA_TOOLKIT_FIGMA_TOKEN、FIGMA_TOKEN、FIGMA_TOOLKIT_BASE_URL - 本地配置文件
~/.figma-toolkit-cli/config.json - 默认官方地址
https://api.figma.com