https://github.com/pinatacloud/pinata-cli

A CLI tool for uploading files and folders to Pinata
https://github.com/pinatacloud/pinata-cli

Last synced: 17 days ago
JSON representation

A CLI tool for uploading files and folders to Pinata

• Host: GitHub
• URL: https://github.com/pinatacloud/pinata-cli
• Owner: PinataCloud
• Created: 2021-11-10T16:58:57.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-04T14:27:29.000Z (about 2 years ago)
• Last Synced: 2023-03-02T15:36:39.495Z (almost 2 years ago)
• Language: JavaScript
• Homepage:
• Size: 19.5 KB
• Stars: 19
• Watchers: 3
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Pinata Upload CLI

### What is this?

This is a simple command line tools designed to allow developers (and those familiar with the command line) to easily upload files and folders to their Pinata account. It is specifically built to help with large folder uploads. 

### How to use this CLI

Make sure you are using a recent version of Node. I recommend `14.17.6` or above.

First, you have to install it.

`npm i -g pinata-upload-cli`

Once it's installed, you will be able to check all the functionality by running: 

`pinata-cli -h` 

You can upload files and folders using this CLI, and you can upload them to the public IPFS network through Pinata, or you can Submarine them. [Read more about Submarining here](https://www.pinata.cloud/blog/introducing-submarining-what-it-is-why-you-need-it). 

To upload to the public IPFS network, you'll need a Pinata V1 API Key JWT. To upload to Pinata Submarine, you'll need a V2 API Key. Both of these are easily available in the Pinata web app once you've created an account. 

**Note: Pinata Submarine is only available on paid Professional Plans.**

### Example Usage 

Authenticate Public IPFS: 

```

pinata-cli -a [Pinata JWT]

```

Authenticate Submarining: 

```

pinata-cli -as [Pinata V2 API Key]

```

Upload a folder or file to public IPFS: 

```

pinata-cli -u ../../../test/folder/relative/path

```

Upload a folder or file to private Pinata Submarine: 

```

pinata-cli -s ../../../test/folder/relative/path

```