https://github.com/2color/auspinner

Stateless CLI tool to easily pin CAR files to IPFS pinning services. Client for the IPFS Pinning Service API that speaks HTTP and Bitswap.
https://github.com/2color/auspinner

bitswap ipfs libp2p pinning-api

Last synced: 3 days ago
JSON representation

Stateless CLI tool to easily pin CAR files to IPFS pinning services. Client for the IPFS Pinning Service API that speaks HTTP and Bitswap.

• Host: GitHub
• URL: https://github.com/2color/auspinner
• Owner: 2color
• License: other
• Created: 2022-06-05T15:34:44.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T20:28:14.000Z (11 months ago)
• Last Synced: 2024-11-02T00:42:18.392Z (7 days ago)
• Topics: bitswap, ipfs, libp2p, pinning-api
• Language: Go
• Homepage:
• Size: 384 KB
• Stars: 15
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-starred - 2color/auspinner - Stateless CLI tool to easily pin CAR files to IPFS pinning services. Client for the IPFS Pinning Service API that speaks HTTP and Bitswap. (ipfs)

README

        
# Auspinner

![auspinner logo](./logo.png)

`auspinner` is a stateless CLI tool to easily pin CAR files to IPFS pinning services. It's essentially a client for the [IPFS Pinning Service API](https://ipfs.github.io/pinning-services-api-spec/) that speaks HTTP and [Bitswap](https://docs.ipfs.io/concepts/bitswap/).

![Flow diagram](diagram.png)

Made with ❤️ during [Protocol Labs Launchpad](https://protocol.ai/blog/announcing-pl-launchpad/)

## Features

- List pins and by status

- Delete pins by their pin request ID

- Add pins

  - Serve them over Bitswap by connecting to the delegates returned from the pinning service

  - Alternatively, if no delegates are returned, the `--use-origins` flag uses libp2p NAT port mapping to get a public address which is passed in the origins to the pinning service

## Supported pinning services

Auspinner has been tested to work with:

- [nft.storage](https://nft.storage/)

- [web3.storage](https://web3.storage/)

- [pinata](https://www.pinata.cloud/)

- [estuary](https://estuary.tech/)

- [Filebase](https://docs.filebase.com/storage-networks/ipfs/ipfs-pinning)

Check out [the pinning service compliance reports](https://ipfs-shipyard.github.io/pinning-service-compliance/) to see which services are correctly implementing the IPFS Pinning Service API Spec.

## Usage demo

![GIF demo](https://bafybeibulywfk4qkht2unofqmnjovbh24wyjknh5u5llvld4snequz2taa.ipfs.nftstorage.link/)

## Credits

Big thanks to a bunch of brilliant developers who either helped along the way or built tools and libraries that Auspinner uses:

- https://github.com/aschmahmann

- https://github.com/lidel

- https://github.com/ajnavarro

- https://github.com/sgtpooki

- https://github.com/willscott

- https://github.com/marten-seemann