https://github.com/pinatacloud/ipfs-cli
https://github.com/pinatacloud/ipfs-cli
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pinatacloud/ipfs-cli
- Owner: PinataCloud
- Created: 2025-02-27T03:33:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-17T17:25:54.000Z (about 1 year ago)
- Last Synced: 2025-06-17T18:30:53.214Z (about 1 year ago)
- Language: Go
- Size: 6.74 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Pinata IPFS CLI
The official CLI for the Pinata API written in Go
## Installation
> [!NOTE]
> 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`
### Install Script
The easiest way to install is to copy and paste this script into your terminal
```bash
curl -fsSL https://cli.pinata.cloud/install | bash
```
### Homebrew
If you are on MacOS and have homebrew installed you can run the command below to install the CLI
```
brew install PinataCloud/ipfs-cli/ipfs-cli
```
### Building from Source
To build and instal from source make sure you have [Go](https://go.dev/) installed on your computer and the following command returns a version:
```
go version
```
Then paste and run the following into your terminal:
```
git clone https://github.com/PinataCloud/ipfs-cli && cd ipfs-cli && go install .
```
### Linux Binary
As 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.
For example, this is how I install the CLI for my Raspberry Pi
```
wget https://github.com/PinataCloud/ipfs-cli/releases/download/v0.1.0/ipfs-cli_Linux_arm64.tar.gz
tar -xzf files-cli_Linux_arm64.tar.gz
sudo mv pinata /usr/bin
```
## Usage
The Pinata CLI is equipped with the majortiry of features on both the Public IPFS API and Private IPFS API.
### `auth`
With 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!
```
pinata auth
```
### `config`
Set a default IPFS network, can be either `public` or `private`. You can always change this at any time or override in individual commands.
```
NAME:
pinata config - Configure Pinata CLI settings
USAGE:
pinata config command [command options] [arguments...]
COMMANDS:
network, net Set default network (public or private)
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help
```
### `upload`
```
NAME:
pinata upload - Upload a file to Pinata
USAGE:
pinata upload [command options] [path to file]
OPTIONS:
--group value, -g value Upload a file to a specific group by passing in the groupId
--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")
--verbose Show upload progress (default: false)
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
### `files`
```
NAME:
pinata files - Interact with your files on Pinata
USAGE:
pinata files command [command options] [arguments...]
COMMANDS:
delete, d Delete a file by ID
get, g Get file info by ID
update, u Update a file by ID
list, l List most recent files
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help
```
#### `get`
```
NAME:
pinata files get - Get file info by ID
USAGE:
pinata files get [command options] [ID of file]
OPTIONS:
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
#### `list`
```
NAME:
pinata files list - List most recent files
USAGE:
pinata files list [command options] [arguments...]
OPTIONS:
--name value, -n value Filter by name of the target file
--cid value, -c value Filter results by CID
--group value, -g value Filter results by group ID
--mime value, -m value Filter results by file mime type
--amount value, -a value The number of files you would like to return
--token value, -t value Paginate through file results using the pageToken
--cidPending Filter results based on whether or not the CID is pending (default: false)
--keyvalues value, --kv value [ --keyvalues value, --kv value ] Filter results by metadata keyvalues (format: key=value)
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
#### `update`
```
NAME:
pinata files update - Update a file by ID
USAGE:
pinata files update [command options] [ID of file]
OPTIONS:
--name value, -n value Update the name of a file
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
#### `delete`
```
NAME:
pinata files delete - Delete a file by ID
USAGE:
pinata files delete [command options] [ID of file]
OPTIONS:
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
### `groups`
```
NAME:
pinata groups - Interact with file groups
USAGE:
pinata groups command [command options] [arguments...]
COMMANDS:
create, c Create a new group
list, l List groups on your account
update, u Update a group
delete, d Delete a group by ID
get, g Get group info by ID
add, a Add a file to a group
remove, r Remove a file from a group
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help
```
#### `create`
```
NAME:
pinata groups create - Create a new group
USAGE:
pinata groups create [command options] [name of group]
OPTIONS:
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
#### `get`
```
NAME:
pinata groups get - Get group info by ID
USAGE:
pinata groups get [command options] [ID of group]
OPTIONS:
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
#### `list`
```
NAME:
pinata groups list - List groups on your account
USAGE:
pinata groups list [command options] [arguments...]
OPTIONS:
--amount value, -a value The number of groups you would like to return (default: "10")
--name value, -n value Filter groups by name
--token value, -t value Paginate through results using the pageToken
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
#### `add`
```
NAME:
pinata groups add - Add a file to a group
USAGE:
pinata groups add [command options] [group id] [file id]
OPTIONS:
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
#### `remove`
```
NAME:
pinata groups remove - Remove a file from a group
USAGE:
pinata groups remove [command options] [group id] [file id]
OPTIONS:
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
### `gateways`
```
NAME:
pinata gateways - Interact with your gateways on Pinata
USAGE:
pinata gateways command [command options] [arguments...]
COMMANDS:
set, s Set your default gateway to be used by the CLI
open, o Open a file in the browser
link, l Get either an IPFS link for a public file or a temporary access link for a Private IPFS file
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help
```
#### `set`
```
NAME:
pinata gateways set - Set your default gateway to be used by the CLI
USAGE:
pinata gateways set [command options] [domain of the gateway]
OPTIONS:
--help, -h show help
```
#### `link`
```
NAME:
pinata gateways link - Get either an IPFS link for a public file or a temporary access link for a Private IPFS file
USAGE:
pinata gateways link [command options] [cid of the file, seconds the url is valid for]
OPTIONS:
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
#### `open`
```
NAME:
pinata gateways open - Open a file in the browser
USAGE:
pinata gateways open [command options] [CID of the file]
OPTIONS:
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
### `keys`
```
NAME:
pinata keys - Create and manage generated API keys
USAGE:
pinata keys command [command options] [arguments...]
COMMANDS:
create, c Create an API key with admin or scoped permissions
list, l List and filter API key
revoke, r Revoke an API key
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help
```
#### `create`
```
NAME:
pinata keys create - Create an API key with admin or scoped permissions
USAGE:
pinata keys create [command options] [arguments...]
OPTIONS:
--name value, -n value Name of the API key
--admin, -a Set the key as Admin (default: false)
--uses value, -u value Max uses a key can use (default: 0)
--endpoints value, -e value [ --endpoints value, -e value ] Optional array of endpoints the key is allowed to use
--help, -h show help
```
#### `list`
```
NAME:
pinata keys list - List and filter API key
USAGE:
pinata keys list [command options] [arguments...]
OPTIONS:
--name value, -n value Name of the API key
--revoked, -r Set the key as Admin (default: false)
--exhausted, -e Filter keys that are exhausted or not (default: false)
--uses, -u Filter keys that do or don't have limited uses (default: false)
--offset value, -o value Offset the number of results to paginate
--help, -h show help
```
#### `revoke`
```
NAME:
pinata keys revoke - Revoke an API key
USAGE:
pinata keys revoke [command options] [key]
OPTIONS:
--help, -h show help
```
### `swaps`
```
NAME:
pinata swaps - Interact and manage hot swaps on Pinata
USAGE:
pinata swaps command [command options] [arguments...]
COMMANDS:
list, l List swaps for a given gateway domain or for your config gateway domain
add, a Add a swap for a CID
delete, d Remeove a swap for a CID
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help
```
#### `list`
```
NAME:
pinata swaps list - List swaps for a given gateway domain or for your config gateway domain
USAGE:
pinata swaps list [command options] [cid] [optional gateway domain]
OPTIONS:
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
#### `add`
```
NAME:
pinata swaps add - Add a swap for a CID
USAGE:
pinata swaps add [command options] [cid] [swap cid]
OPTIONS:
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
#### `delete`
```
NAME:
pinata swaps delete - Remeove a swap for a CID
USAGE:
pinata swaps delete [command options] [cid]
OPTIONS:
--network value, --net value Specify the network (public or private). Uses default if not specified
--help, -h show help
```
## Contact
If you have any questions please feel free to reach out to us!
[team@pinata.cloud](mailto:team@pinata.cloud)