2022-11-02 18:09:22 +00:00
|
|
|
[![npm](https://img.shields.io/npm/v/@kredits/ipfs-pinner.svg)](https://www.npmjs.com/package/@kredits/ipfs-pinner)
|
|
|
|
|
2019-07-02 16:45:24 +00:00
|
|
|
# Kredits IPFS Pinner
|
2019-07-02 14:20:52 +00:00
|
|
|
|
2022-11-01 15:26:18 +00:00
|
|
|
This tool pins the IPFS documents of a Kredits organization on any IPFS node.
|
2019-07-02 14:20:52 +00:00
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
2019-07-02 16:51:29 +00:00
|
|
|
Make sure you have a local IPFS node running. (See `--help` for custom IPFS
|
|
|
|
config flags, in case it is not running on localhost with default ports.)
|
|
|
|
|
2019-07-02 16:45:24 +00:00
|
|
|
### With NPX magic
|
2019-07-02 14:20:52 +00:00
|
|
|
|
2022-11-01 15:26:18 +00:00
|
|
|
npx @kredits/ipfs-pinner
|
2019-07-02 16:45:24 +00:00
|
|
|
|
|
|
|
### Global install
|
|
|
|
|
2022-11-01 15:26:18 +00:00
|
|
|
npm install -g @kredits/ipfs-pinner
|
2019-07-02 16:45:24 +00:00
|
|
|
kredits-ipfs-pinner
|
|
|
|
|
|
|
|
### From repo
|
|
|
|
|
|
|
|
Clone the Git repository, then use npm scripts from its root directory.
|
|
|
|
|
|
|
|
npm start
|
|
|
|
|
|
|
|
Or with debug output:
|
|
|
|
|
|
|
|
npm run debug
|
2023-04-26 13:17:11 +00:00
|
|
|
|
|
|
|
### CLI options
|
|
|
|
|
|
|
|
Display progress bars:
|
|
|
|
|
|
|
|
kredits-ipfs-pinner --progress
|
|
|
|
|
|
|
|
Or with npm:
|
|
|
|
|
|
|
|
npm start -- --progress
|
|
|
|
|
|
|
|
Keep running and watch for new data/documents:
|
|
|
|
|
|
|
|
kredits-ipfs-pinner --watch
|
|
|
|
|
|
|
|
Multiple options at once:
|
|
|
|
|
|
|
|
kredits-ipfs-pinner --progress --watch
|