Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 2.61 KB

README.md

File metadata and controls

83 lines (56 loc) · 2.61 KB
Raw

ipget

standard-readme compliant Build Status

wget for IPFS: retrieve files over IPFS and save them locally.

ipget is a standalone program analogous to GNU wget. Unlike wget though, ipget specializes in downloading files and directory structures from the IPFS network.

ipget includes its own IPFS node, so you don't need IPFS installed on your system. This makes it ideal for users and projects that want a simple utility for whenever they want to retrieve files from IPFS.

Install

Download a binary for your platform from IPFS Distributions.

Install From Source

ipget doesn't use the vanilla Go package management system. It instead uses the gx (and gx-go) workflow. This means a slightly different set of steps to install:

$ go get -d github.com/ipfs/ipget

$ cd ${GOPATH}/src/github.com/ipfs/ipget

$ make install

Example

Find a fun IPFS address and ipget away!

$ ipget QmQ2r6iMNpky5f1m4cnm3Yqw8VSvjuKpTcK1X7dBR1LkJF/cat.gif -o nyan.gif

or with an /ipfs prefix:

$ ipget -o nyan.gif /ipfs/QmQ2r6iMNpky5f1m4cnm3Yqw8VSvjuKpTcK1X7dBR1LkJF/cat.gif

or even IPNS addresses:

$ ipget /ipns/QmQG1kwx91YQsGcsa9Z1p6BPJ3amdiSLLmsmAoEMwbX61b/files/cat.gif

Usage

NAME:
   ipget - Retrieve and save IPFS objects.

USAGE:
   ipget [global options] command [command options] [arguments...]

VERSION:
   0.2.0

COMMANDS:
GLOBAL OPTIONS:
   --output value, -o value  specify output location
   --help, -h                show help
   --version, -v             print the version

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

License

MIT