{"id":14981567,"url":"https://github.com/b3nnyl/figgo","last_synced_at":"2025-04-06T04:06:54.861Z","repository":{"id":40313610,"uuid":"167291941","full_name":"B3nnyL/figgo","owner":"B3nnyL","description":"👯‍♀️A cli tool makes your Figma and local design token stay in sync 👯‍♂️ ","archived":false,"fork":false,"pushed_at":"2023-01-06T04:52:10.000Z","size":1414,"stargazers_count":308,"open_issues_count":15,"forks_count":15,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-06T04:06:30.606Z","etag":null,"topics":["cli","design-system","figma","ui"],"latest_commit_sha":null,"homepage":"https://github.com/B3nnyL/figgo","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/B3nnyL.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-24T02:53:01.000Z","updated_at":"2025-02-05T02:06:58.000Z","dependencies_parsed_at":"2023-02-05T09:01:05.476Z","dependency_job_id":null,"html_url":"https://github.com/B3nnyL/figgo","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/B3nnyL%2Ffiggo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/B3nnyL%2Ffiggo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/B3nnyL%2Ffiggo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/B3nnyL%2Ffiggo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/B3nnyL","download_url":"https://codeload.github.com/B3nnyL/figgo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247430866,"owners_count":20937874,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","design-system","figma","ui"],"created_at":"2024-09-24T14:03:51.458Z","updated_at":"2025-04-06T04:06:54.841Z","avatar_url":"https://github.com/B3nnyL.png","language":"TypeScript","readme":"\u003ch1 align=\"center\"\u003eFiggo\u003c/h1\u003e\n\u003cp align=\"center\"\u003eA CLI tool make your design tokens always stay up to date with your Figma design styleguide\u003c/p\u003e\n\n![img](https://img.shields.io/travis/B3nnyL/figgo/master.svg)\n\n![img](assets/cover.png)\n\n## Install Figgo\n\n`npm i figgo -g`\n\n## Figma Guide\n\n- Create three frames named as `Typography`, `Palette` and `Space` in your figma file.\n- Spread out your typography, color and spacing examples to the frames. Follow this [figma example](https://www.figma.com/file/ULXceywc0RjE0MFYNgOiZDrl/Figgo) for the best outcomes.\n- Grab the figma file's id.\n- Generate your personal token at `account setting` and grab it.\n\n## Terminal Guide\n\nAssume you have already installed Figgo...\n\n### Global setup\n\n- Run `figgo --init`, answer a few setup questions where you will leave file id and personal token with Figgo. All configuration will save to `~/.figgo`. **_Note: output directory needs to be absolute path._**\n- Tied your belt and type `figgo --sync`, let tokens store in the location you wish.\n- You may run `figgo --sync board_name` to update tokens selectively.\n\n### Local setup\n\n- Create `figgo.json` file under your project directory.\n\n```json\n{\n  \"boards\": [\n    {\n      \"boardName\": \"your board name\",\n      \"id\": \"figma id\",\n      \"outputDir\": \"output directory (this can be a path relative to your project)\",\n      \"outputFormat\": \"js or scss\",\n      \"token\": \"your figma personal token\"\n    },\n    {\n      ...\n    }\n  ]\n}\n```\n\n- Run `figgo --sync` and all tokens will store in the path you wish or update selectively via appending board name.\n\n## Basic CLI Usage\n\n```shell\nHow to use\n    $ figgo [\u003coptions\u003e ...]\n    Options\n      --init, -i         Setup figma board and store configurations to global config files\n      --sync, -s         Sync tokens based on (global/local) config files\n      --edit, -e         Edit board information (not ready yet)\n      --list, -l         List boards from global config files\n      --remove, -r       Remove board from global config files\n      --help, -h         Show help message\n      --version, -v      Show installed version\n    Examples\n      $ figgo --init\n      $ figgo --init board_name board_id output_absolute_path output_format(js|scss) figma_token\n      $ figgo --edit board_name (not ready yet)\n      $ figgo --list\n      $ figgo --sync\n      $ figgo --sync board_name\n      $ figgo --remove board_name\n      $ figgo --help\n      $ figgo --version\n```\n\n### Sync Token\n\n![url](https://i.imgur.com/wfWei0q.gif)\n\n## Manual configuration\n\nEdit setup configuration from `config.js` in `~/.figgo` folder. You can also manually add Figma board through editting this file.\n\n## Dev Guide\n\n- Installation\n  `yarn install`\n- development\n  `yarn start [options]`\n- test\n  `yarn test`\n- build\n  `yarn build`\n\n## Changelogs\n\n- 0.1.1 🚀 Alive\n- 0.1.2 ✍️ Readme\n- 0.1.3 🛠 Fix minor issues\n- 0.1.5 🤠 Better UX\n- 0.1.8 🤠 Project figgo.json is supported\n- 0.1.11 🤠Fix minor issues and improve UX\n\n- 0.2 🧩Support css variable, fixed test and CI\n\n## TODOs\n\n- [x] CLI listing board information\n- [x] CLI specify board sync\n- [x] js output supports\n- [x] css variable support\n- [ ] Edit Figma board info from CLI\n- [x] Well-formatted and styled output in terminal\n- [ ] More screenshots and documentation\n\n## License\n\nMIT\n\n## Credits\n\n[Figma](https://www.figma.com)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb3nnyl%2Ffiggo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fb3nnyl%2Ffiggo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb3nnyl%2Ffiggo/lists"}