@mstrathman/figma 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-01-17
+
+### Added
+
+- Initial release of @mstrathman/figma
+- Authentication via OAuth and personal access tokens
+- File operations: get file info, list nodes, export images
+- Component operations: list and get component details
+- Style operations: list and get style details
+- Variable operations: list and export variables
+- Export capabilities: design tokens, icons, theme files
+- Project operations: list projects and files
+- Support for JSON and table output formats

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 mstrathman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,214 @@
+# figma
+
+A command-line interface for the Figma API, inspired by GitHub's `gh` CLI. Built for design-to-code workflows.
+
+> **Note:** This is an unofficial tool and is not affiliated with or endorsed by Figma, Inc.
+
+## Installation
+
+```bash
+npm install -g @mstrathman/figma
+```
+
+### From source
+
+```bash
+git clone https://github.com/mstrathman/figma.git
+cd figma
+npm install
+npm run build
+npm link
+```
+
+## Authentication
+
+### Personal Access Token (Recommended)
+
+Get a token from [Figma Developer Settings](https://www.figma.com/developers/api#access-tokens).
+
+```bash
+# Interactive login
+figma auth login
+
+# Or with token directly
+figma auth login --token <your-token>
+
+# Or use environment variable
+export FIGMA_TOKEN=<your-token>
+```
+
+### OAuth (Browser Login)
+
+For OAuth, you need to [create a Figma app](https://www.figma.com/developers/apps) first.
+
+```bash
+# Set credentials
+export FIGMA_CLIENT_ID=<your-client-id>
+export FIGMA_CLIENT_SECRET=<your-client-secret>
+
+# Login via browser
+figma auth login --web
+```
+
+### Check Status
+
+```bash
+figma auth status
+```
+
+## Commands
+
+### Files
+
+```bash
+# Get file structure
+figma file get <file-key>
+
+# Get specific nodes
+figma file nodes <file-key> --ids "1:2,1:3"
+
+# Export images
+figma file images <file-key> --ids "1:2" --format svg --output ./icons
+```
+
+### Projects
+
+```bash
+# List team projects
+figma project list --team <team-id>
+
+# List files in a project
+figma project files <project-id>
+```
+
+### Components
+
+```bash
+# List components in a file
+figma component list --file <file-key>
+
+# List team components
+figma component list --team <team-id>
+
+# Get component details
+figma component get <component-key>
+```
+
+### Styles
+
+```bash
+# List styles in a file
+figma style list --file <file-key>
+
+# List team styles
+figma style list --team <team-id>
+
+# Get style details
+figma style get <style-key>
+```
+
+### Variables (Enterprise)
+
+```bash
+# List variables
+figma variable list <file-key>
+
+# Export as design tokens
+figma variable export <file-key> --format css --output tokens.css
+figma variable export <file-key> --format style-dictionary --output tokens.json
+```
+
+### Export (Design-to-Code)
+
+```bash
+# Export design tokens
+figma export tokens <file-key> --format css
+figma export tokens <file-key> --format scss
+figma export tokens <file-key> --format tailwind
+figma export tokens <file-key> --format style-dictionary
+
+# Export icons
+figma export icons <file-key> --frame "Icons" --format svg --output ./icons
+
+# Export complete theme package
+figma export theme <file-key> --formats "css,json,tailwind" --output ./theme
+```
+
+### Raw API Access
+
+```bash
+# GET request
+figma api /v1/me
+
+# With query parameters
+figma api /v1/files/<key>/images -q "ids=1:2,format=svg"
+
+# POST request
+figma api /v1/files/<key>/comments -X POST -d '{"message":"Hello"}'
+```
+
+## Output Formats
+
+Most commands support `--format` for output:
+
+- `json` (default) - JSON output, great for piping to `jq`
+- `table` - Human-readable table format
+
+```bash
+figma component list --file <key> --format table
+```
+
+## Configuration
+
+Configuration is loaded in this priority order:
+
+1. Environment variables (`FIGMA_TOKEN`, `FIGMA_TEAM_ID`)
+2. Command-line flags (`--token`)
+3. Local config (`.figmarc` in current directory)
+4. User config (`~/.config/figma/config.json`)
+
+## File Keys
+
+File keys can be found in Figma URLs:
+
+```
+https://www.figma.com/file/ABC123xyz/My-Design
+                           ^^^^^^^^^
+                           This is the file key
+```
+
+## Examples
+
+### Export a design system
+
+```bash
+# Export tokens as CSS variables
+figma export tokens ABC123xyz --format css --output ./src/styles/tokens.css
+
+# Export all icons as SVGs
+figma export icons ABC123xyz --frame "Icons" --output ./src/assets/icons
+
+# Export complete theme
+figma export theme ABC123xyz --output ./src/theme
+```
+
+### Automate with scripts
+
+```bash
+# Get all components and process with jq
+figma component list --file ABC123xyz | jq '.meta.components[].name'
+
+# Export specific nodes as PNGs
+figma file images ABC123xyz --ids "1:2,1:3,1:4" --format png --scale 2 --output ./exports
+```
+
+## Tech Stack
+
+- TypeScript
+- Commander.js (CLI framework)
+- `@figma/rest-api-spec` (official Figma API types)
+- keytar (secure credential storage)
+
+## License
+
+MIT

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+
+export {  }