{"id":15927659,"url":"https://github.com/kevinbluer/truffle-plugin-caramel","last_synced_at":"2026-01-21T02:07:25.096Z","repository":{"id":146484410,"uuid":"279419707","full_name":"kevinbluer/truffle-plugin-caramel","owner":"kevinbluer","description":"Adding caramel gooeyness (aka artifact persistence via Pinata's IPFS pinning service) to Truffle.","archived":false,"fork":false,"pushed_at":"2023-07-15T11:17:01.000Z","size":53,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-08T09:16:20.684Z","etag":null,"topics":["artifacts","decentralized","ipfs","pinata","pinning","storage","truffle"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/kevinbluer.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-13T21:54:23.000Z","updated_at":"2020-09-17T21:07:09.000Z","dependencies_parsed_at":"2025-05-11T19:00:50.723Z","dependency_job_id":null,"html_url":"https://github.com/kevinbluer/truffle-plugin-caramel","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/kevinbluer/truffle-plugin-caramel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinbluer%2Ftruffle-plugin-caramel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinbluer%2Ftruffle-plugin-caramel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinbluer%2Ftruffle-plugin-caramel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinbluer%2Ftruffle-plugin-caramel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevinbluer","download_url":"https://codeload.github.com/kevinbluer/truffle-plugin-caramel/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinbluer%2Ftruffle-plugin-caramel/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28622473,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T23:49:58.628Z","status":"online","status_checked_at":"2026-01-21T02:00:08.227Z","response_time":86,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["artifacts","decentralized","ipfs","pinata","pinning","storage","truffle"],"created_at":"2024-10-06T23:03:23.965Z","updated_at":"2026-01-21T02:07:25.072Z","avatar_url":"https://github.com/kevinbluer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Caramel\n\nAdding caramel gooeyness (aka artifact persistence via [Pinata's](http://pinata.cloud/) IPFS pinning service) to [Truffle](https://www.trufflesuite.com/) 🍬\n\n## Installation\n\nBegin by adding to your Truffle project via the following:\n\n```\nnpm i truffle-plugin-caramel\n```\n\nAdd the following to your `truffle-config.json`:\n\n```\nplugins: [\n  \"truffle-plugin-caramel\"\n]\n```\n\nFinally, create a `.env` file in the project's root directory with your Pinata API key (PINATA_API_KEY) and secret (PINATA_API_SECRET). These can be found under your [account page](https://pinata.cloud/account). Example as follows:\n\n```\nPINATA_API_KEY=deadbeef\nPINATA_API_SECRET=1234567890\n```\n\n## Usage\n\nTo run the plugin, simple run the following command from the root of your Truffle project:\n\n```\ntruffle run caramel \u003ccommand\u003e\n```\n\nThe list available commands is currently as follows:\n\n- [upload](#upload)\n- [list](#list)\n- [unpin](#unpin)\n\n\u003ca name=\"upload\"\u003e\u003c/a\u003e\n### `Upload`\n\nThe following uploads your [Truffle artifacts](https://www.trufflesuite.com/docs/truffle/advanced/networks-and-app-deployment#build-artifacts).\n\n```\ntruffle run caramel upload [\u003cpath\u003e]\n```\n\nOptions:\n\n- **path** - Specifies the path (either to a directory or a file) that you would like to explicitly upload. If omitted, it will default to uploading your Truffle artifacts.\n\n\u003ca name=\"list\"\u003e\u003c/a\u003e\n### `List`\n\nThe following retrieves a list of all your pins currently pinned on Pinata.\n\n```\ntruffle run caramel list\n```\n\n\u003ca name=\"unpin\"\u003e\u003c/a\u003e\n### `Unpin`\n\nThe following unpins an ipfs hash currently pinned by Pinata.\n\n```\ntruffle run caramel unpin \u003cipfs-hash\u003e\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinbluer%2Ftruffle-plugin-caramel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevinbluer%2Ftruffle-plugin-caramel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinbluer%2Ftruffle-plugin-caramel/lists"}