{"id":31758340,"url":"https://github.com/pinatacloud/ipfs-cli","last_synced_at":"2025-10-09T20:08:14.020Z","repository":{"id":280541199,"uuid":"939749169","full_name":"PinataCloud/ipfs-cli","owner":"PinataCloud","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-17T17:25:54.000Z","size":7071,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-17T18:30:53.214Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PinataCloud.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2025-02-27T03:33:00.000Z","updated_at":"2025-06-17T17:25:27.000Z","dependencies_parsed_at":"2025-03-04T02:22:13.354Z","dependency_job_id":"d2bedf99-5220-45e2-bcbf-096354502d75","html_url":"https://github.com/PinataCloud/ipfs-cli","commit_stats":null,"previous_names":["pinatacloud/ipfs-cli"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/PinataCloud/ipfs-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PinataCloud%2Fipfs-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PinataCloud%2Fipfs-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PinataCloud%2Fipfs-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PinataCloud%2Fipfs-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PinataCloud","download_url":"https://codeload.github.com/PinataCloud/ipfs-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PinataCloud%2Fipfs-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002016,"owners_count":26083258,"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","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"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":[],"created_at":"2025-10-09T20:08:11.141Z","updated_at":"2025-10-09T20:08:14.015Z","avatar_url":"https://github.com/PinataCloud.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pinata IPFS CLI\n\n![cover](https://dweb.mypinata.cloud/ipfs/QmNcdx9t48z7RQUXUZZHmuc4zBfyBxKLjDfEgmfhiop7j7?img-format=webp)\nThe official CLI for the Pinata API written in Go\n\n## Installation\n\n\u003e [!NOTE]\n\u003e If you are on Windows please use WSL when installing. If you get an error that it was not able to resolve the github host run `git config --global --unset http.proxy`\n\n### Install Script\n\nThe easiest way to install is to copy and paste this script into your terminal\n\n```bash\ncurl -fsSL https://cli.pinata.cloud/install | bash\n```\n\n### Homebrew\n\nIf you are on MacOS and have homebrew installed you can run the command below to install the CLI\n\n```\nbrew install PinataCloud/ipfs-cli/ipfs-cli\n```\n\n### Building from Source\n\nTo build and instal from source make sure you have [Go](https://go.dev/) installed on your computer and the following command returns a version:\n\n```\ngo version\n```\n\nThen paste and run the following into your terminal:\n\n```\ngit clone https://github.com/PinataCloud/ipfs-cli \u0026\u0026 cd ipfs-cli \u0026\u0026 go install .\n```\n\n### Linux Binary\n\nAs versions are released you can visit the [Releases](https://github.com/PinataCloud/ipfs-cli/releases) page and download the appropriate binary for your system, them move it into your bin folder.\n\nFor example, this is how I install the CLI for my Raspberry Pi\n\n```\nwget https://github.com/PinataCloud/ipfs-cli/releases/download/v0.1.0/ipfs-cli_Linux_arm64.tar.gz\n\ntar -xzf files-cli_Linux_arm64.tar.gz\n\nsudo mv pinata /usr/bin\n```\n\n## Usage\n\nThe Pinata CLI is equipped with the majortiry of features on both the Public IPFS API and Private IPFS API.\n\n### `auth`\n\nWith the CLI installed you will first need to authenticate it with your [Pinata JWT](https://docs.pinata.cloud/account-management/api-keys). Run this command and follow the steps to setup the CLI!\n\n```\npinata auth\n```\n\n### `config`\n\nSet a default IPFS network, can be either `public` or `private`. You can always change this at any time or override in individual commands.\n\n```\nNAME:\n   pinata config - Configure Pinata CLI settings\n\nUSAGE:\n   pinata config command [command options] [arguments...]\n\nCOMMANDS:\n   network, net  Set default network (public or private)\n   help, h       Shows a list of commands or help for one command\n\nOPTIONS:\n   --help, -h  show help\n```\n\n### `upload`\n\n```\nNAME:\n   pinata upload - Upload a file to Pinata\n\nUSAGE:\n   pinata upload [command options] [path to file]\n\nOPTIONS:\n   --group value, -g value  Upload a file to a specific group by passing in the groupId\n   --name value, -n value   Add a name for the file you are uploading. By default it will use the filename on your system. (default: \"nil\")\n   --verbose                Show upload progress (default: false)\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h               show help\n```\n\n### `files`\n\n```\nNAME:\n   pinata files - Interact with your files on Pinata\n\nUSAGE:\n   pinata files command [command options] [arguments...]\n\nCOMMANDS:\n   delete, d  Delete a file by ID\n   get, g     Get file info by ID\n   update, u  Update a file by ID\n   list, l    List most recent files\n   help, h    Shows a list of commands or help for one command\n\nOPTIONS:\n   --help, -h  show help\n```\n\n#### `get`\n\n```\nNAME:\n   pinata files get - Get file info by ID\n\nUSAGE:\n   pinata files get [command options] [ID of file]\n\nOPTIONS:\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n#### `list`\n\n```\nNAME:\n   pinata files list - List most recent files\n\nUSAGE:\n   pinata files list [command options] [arguments...]\n\nOPTIONS:\n   --name value, -n value                                           Filter by name of the target file\n   --cid value, -c value                                            Filter results by CID\n   --group value, -g value                                          Filter results by group ID\n   --mime value, -m value                                           Filter results by file mime type\n   --amount value, -a value                                         The number of files you would like to return\n   --token value, -t value                                          Paginate through file results using the pageToken\n   --cidPending                                                     Filter results based on whether or not the CID is pending (default: false)\n   --keyvalues value, --kv value [ --keyvalues value, --kv value ]  Filter results by metadata keyvalues (format: key=value)\n   --network value, --net value                                     Specify the network (public or private). Uses default if not specified\n   --help, -h                                                       show help\n```\n\n#### `update`\n\n```\nNAME:\n   pinata files update - Update a file by ID\n\nUSAGE:\n   pinata files update [command options] [ID of file]\n\nOPTIONS:\n   --name value, -n value        Update the name of a file\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n#### `delete`\n\n```\nNAME:\n   pinata files delete - Delete a file by ID\n\nUSAGE:\n   pinata files delete [command options] [ID of file]\n\nOPTIONS:\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n### `groups`\n\n```\nNAME:\n   pinata groups - Interact with file groups\n\nUSAGE:\n   pinata groups command [command options] [arguments...]\n\nCOMMANDS:\n   create, c  Create a new group\n   list, l    List groups on your account\n   update, u  Update a group\n   delete, d  Delete a group by ID\n   get, g     Get group info by ID\n   add, a     Add a file to a group\n   remove, r  Remove a file from a group\n   help, h    Shows a list of commands or help for one command\n\nOPTIONS:\n   --help, -h  show help\n```\n\n#### `create`\n\n```\nNAME:\n   pinata groups create - Create a new group\n\nUSAGE:\n   pinata groups create [command options] [name of group]\n\nOPTIONS:\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n#### `get`\n\n```\nNAME:\n   pinata groups get - Get group info by ID\n\nUSAGE:\n   pinata groups get [command options] [ID of group]\n\nOPTIONS:\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n#### `list`\n\n```\nNAME:\n   pinata groups list - List groups on your account\n\nUSAGE:\n   pinata groups list [command options] [arguments...]\n\nOPTIONS:\n   --amount value, -a value      The number of groups you would like to return (default: \"10\")\n   --name value, -n value        Filter groups by name\n   --token value, -t value       Paginate through results using the pageToken\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n#### `add`\n\n```\nNAME:\n   pinata groups add - Add a file to a group\n\nUSAGE:\n   pinata groups add [command options] [group id] [file id]\n\nOPTIONS:\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n#### `remove`\n\n```\nNAME:\n   pinata groups remove - Remove a file from a group\n\nUSAGE:\n   pinata groups remove [command options] [group id] [file id]\n\nOPTIONS:\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n### `gateways`\n\n```\nNAME:\n   pinata gateways - Interact with your gateways on Pinata\n\nUSAGE:\n   pinata gateways command [command options] [arguments...]\n\nCOMMANDS:\n   set, s   Set your default gateway to be used by the CLI\n   open, o  Open a file in the browser\n   link, l  Get either an IPFS link for a public file or a temporary access link for a Private IPFS file\n   help, h  Shows a list of commands or help for one command\n\nOPTIONS:\n   --help, -h  show help\n```\n\n#### `set`\n\n```\nNAME:\n   pinata gateways set - Set your default gateway to be used by the CLI\n\nUSAGE:\n   pinata gateways set [command options] [domain of the gateway]\n\nOPTIONS:\n   --help, -h  show help\n```\n\n#### `link`\n\n```\nNAME:\n   pinata gateways link - Get either an IPFS link for a public file or a temporary access link for a Private IPFS file\n\nUSAGE:\n   pinata gateways link [command options] [cid of the file, seconds the url is valid for]\n\nOPTIONS:\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n#### `open`\n\n```\nNAME:\n   pinata gateways open - Open a file in the browser\n\nUSAGE:\n   pinata gateways open [command options] [CID of the file]\n\nOPTIONS:\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n### `keys`\n\n```\nNAME:\n   pinata keys - Create and manage generated API keys\n\nUSAGE:\n   pinata keys command [command options] [arguments...]\n\nCOMMANDS:\n   create, c  Create an API key with admin or scoped permissions\n   list, l    List and filter API key\n   revoke, r  Revoke an API key\n   help, h    Shows a list of commands or help for one command\n\nOPTIONS:\n   --help, -h  show help\n```\n\n#### `create`\n\n```\nNAME:\n   pinata keys create - Create an API key with admin or scoped permissions\n\nUSAGE:\n   pinata keys create [command options] [arguments...]\n\nOPTIONS:\n   --name value, -n value                                       Name of the API key\n   --admin, -a                                                  Set the key as Admin (default: false)\n   --uses value, -u value                                       Max uses a key can use (default: 0)\n   --endpoints value, -e value [ --endpoints value, -e value ]  Optional array of endpoints the key is allowed to use\n   --help, -h                                                   show help\n```\n\n#### `list`\n\n```\nNAME:\n   pinata keys list - List and filter API key\n\nUSAGE:\n   pinata keys list [command options] [arguments...]\n\nOPTIONS:\n   --name value, -n value    Name of the API key\n   --revoked, -r             Set the key as Admin (default: false)\n   --exhausted, -e           Filter keys that are exhausted or not (default: false)\n   --uses, -u                Filter keys that do or don't have limited uses (default: false)\n   --offset value, -o value  Offset the number of results to paginate\n   --help, -h                show help\n```\n\n#### `revoke`\n\n```\nNAME:\n   pinata keys revoke - Revoke an API key\n\nUSAGE:\n   pinata keys revoke [command options] [key]\n\nOPTIONS:\n   --help, -h  show help\n```\n\n### `swaps`\n\n```\nNAME:\n   pinata swaps - Interact and manage hot swaps on Pinata\n\nUSAGE:\n   pinata swaps command [command options] [arguments...]\n\nCOMMANDS:\n   list, l    List swaps for a given gateway domain or for your config gateway domain\n   add, a     Add a swap for a CID\n   delete, d  Remeove a swap for a CID\n   help, h    Shows a list of commands or help for one command\n\nOPTIONS:\n   --help, -h  show help\n```\n\n#### `list`\n\n```\nNAME:\n   pinata swaps list - List swaps for a given gateway domain or for your config gateway domain\n\nUSAGE:\n   pinata swaps list [command options] [cid] [optional gateway domain]\n\nOPTIONS:\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n#### `add`\n\n```\nNAME:\n   pinata swaps add - Add a swap for a CID\n\nUSAGE:\n   pinata swaps add [command options] [cid] [swap cid]\n\nOPTIONS:\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n#### `delete`\n\n```\nNAME:\n   pinata swaps delete - Remeove a swap for a CID\n\nUSAGE:\n   pinata swaps delete [command options] [cid]\n\nOPTIONS:\n   --network value, --net value  Specify the network (public or private). Uses default if not specified\n   --help, -h                    show help\n```\n\n## Contact\n\nIf you have any questions please feel free to reach out to us!\n\n[team@pinata.cloud](mailto:team@pinata.cloud)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinatacloud%2Fipfs-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpinatacloud%2Fipfs-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinatacloud%2Fipfs-cli/lists"}