# Command-line
IPFS can run in either online or offline mode. Online mode is when you have IPFS running separately as a daemon process. If you do not have an IPFS daemon running, you are in offline mode. Some commands, like ipfs swarm peers, are only supported when online. The command-line quickstart guide explains how to start the IPFS daemon and take your node online.
# Alignment with HTTP API
Every command usable from the CLI is also available through the HTTP API. For example:
> ipfs swarm peers
/ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
/ip4/104.236.151.122/tcp/4001/p2p/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx
/ip4/104.236.176.52/tcp/4001/p2p/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z
> curl -X POST http://127.0.0.1:5001/api/v0/swarm/peers
{
"Strings": [
"/ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ",
"/ip4/104.236.151.122/tcp/4001/p2p/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx",
"/ip4/104.236.176.52/tcp/4001/p2p/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z",
]
}
Generated on 2021-02-24 17:19:32, from go-ipfs 0.8.0.
# ipfs
USAGE
ipfs - Global p2p merkle-dag filesystem.
SYNOPSIS
ipfs [--config=<config> | -c] [--debug | -D] [--help] [-h] [--api=<api>] [--offline] [--cid-base=<base>] [--upgrade-cidv0-in-output] [--encoding=<encoding> | --enc] [--timeout=<timeout>] <command> ...
OPTIONS
-c, --config string - Path to the configuration file to use.
-D, --debug bool - Operate in debug mode.
--help bool - Show the full command help text.
-h bool - Show a short version of the command help
text.
-L, --local bool - Run the command locally, instead of using
the daemon. DEPRECATED: use --offline.
--offline bool - Run the command offline.
--api string - Use a specific API instance (defaults to
/ip4/127.0.0.1/tcp/5001).
--cid-base string - Multibase encoding used for version 1
CIDs in output.
--upgrade-cidv0-in-output bool - Upgrade version 0 to version 1 CIDs in
output.
--enc, --encoding string - The encoding type the output should be
encoded with (json, xml, or text).
Default: text.
--stream-channels bool - Stream channel output.
--timeout string - Set a global timeout on the command.
SUBCOMMANDS
BASIC COMMANDS
init Initialize ipfs local configuration
add <path> Add a file to IPFS
cat <ref> Show IPFS object data
get <ref> Download IPFS objects
ls <ref> List links from an object
refs <ref> List hashes of links from an object
DATA STRUCTURE COMMANDS
block Interact with raw blocks in the datastore
object Interact with raw dag nodes
files Interact with objects as if they were a unix filesystem
dag Interact with IPLD documents (experimental)
ADVANCED COMMANDS
daemon Start a long-running daemon process
mount Mount an IPFS read-only mount point
resolve Resolve any type of name
name Publish and resolve IPNS names
key Create and list IPNS name keypairs
dns Resolve DNS links
pin Pin objects to local storage
repo Manipulate the IPFS repository
stats Various operational stats
p2p Libp2p stream mounting
filestore Manage the filestore (experimental)
NETWORK COMMANDS
id Show info about IPFS peers
bootstrap Add or remove bootstrap peers
swarm Manage connections to the p2p network
dht Query the DHT for values or peers
ping Measure the latency of a connection
diag Print diagnostics
TOOL COMMANDS
config Manage configuration
version Show ipfs version information
update Download and apply go-ipfs updates
commands List all available commands
cid Convert and discover properties of CIDs
log Manage and show logs of running daemon
Use 'ipfs <command> --help' to learn more about each command.
ipfs uses a repository in the local file system. By default, the repo is
located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
environment variable:
export IPFS_PATH=/path/to/ipfsrepo
EXIT STATUS
The CLI will exit with one of the following values:
0 Successful execution.
1 Failed executions.
For more information about each command, use:
'ipfs <subcmd> --help'
# ipfs add
USAGE
ipfs add <path>... - Add a file or directory to ipfs.
SYNOPSIS
ipfs add [--recursive | -r] [--dereference-args] [--stdin-name=<stdin-name>]
[--hidden | -H] [--ignore=<ignore>]...
[--ignore-rules-path=<ignore-rules-path>] [--quiet | -q]
[--quieter | -Q] [--silent] [--progress | -p] [--trickle | -t]
[--only-hash | -n] [--wrap-with-directory | -w]
[--chunker=<chunker> | -s] [--pin=false] [--raw-leaves] [--nocopy]
[--fscache] [--cid-version=<cid-version>] [--hash=<hash>] [--inline]
[--inline-limit=<inline-limit>] [--] <path>...
ARGUMENTS
<path>... - The path to a file to be added to ipfs.
OPTIONS
-r, --recursive bool - Add directory paths recursively.
--dereference-args bool - Symlinks supplied in arguments are
dereferenced.
--stdin-name string - Assign a name if the file source is stdin.
-H, --hidden bool - Include files that are hidden. Only takes
effect on recursive add.
--ignore array - A rule (.gitignore-stype) defining which
file(s) should be ignored (variadic,
experimental).
--ignore-rules-path string - A path to a file with .gitignore-style
ignore rules (experimental).
-q, --quiet bool - Write minimal output.
-Q, --quieter bool - Write only final hash.
--silent bool - Write no output.
-p, --progress bool - Stream progress data.
-t, --trickle bool - Use trickle-dag format for dag generation.
-n, --only-hash bool - Only chunk and hash - do not write to
disk.
-w, --wrap-with-directory bool - Wrap files with a directory object.
-s, --chunker string - Chunking algorithm, size-[bytes],
rabin-[min]-[avg]-[max] or buzhash.
Default: size-262144.
--pin bool - Pin this object when adding. Default:
true.
--raw-leaves bool - Use raw blocks for leaf nodes.
(experimental).
--nocopy bool - Add the file using filestore. Implies
raw-leaves. (experimental).
--fscache bool - Check the filestore for pre-existing
blocks. (experimental).
--cid-version int - CID version. Defaults to 0 unless an
option that depends on CIDv1 is passed.
(experimental).
--hash string - Hash function to use. Implies CIDv1 if
not sha2-256. (experimental). Default:
sha2-256.
--inline bool - Inline small blocks into CIDs.
(experimental).
--inline-limit int - Maximum block size to inline.
(experimental). Default: 32.
DESCRIPTION
Adds contents of <path> to ipfs. Use -r to add directories.
Note that directories are added recursively, to form the ipfs
MerkleDAG.
If the daemon is not running, it will just add locally.
If the daemon is started later, it will be advertised after a few
seconds when the reprovider runs.
The wrap option, '-w', wraps the file (or files, if using the
recursive option) in a directory. This directory contains only
the files which have been added, and means that the file retains
its filename. For example:
> ipfs add example.jpg
added QmbFMke1KXqnYyBBWxB74N4c5SBnJMVAiMNRcGu6x1AwQH example.jpg
> ipfs add example.jpg -w
added QmbFMke1KXqnYyBBWxB74N4c5SBnJMVAiMNRcGu6x1AwQH example.jpg
added QmaG4FuMqEBnQNn3C8XJ5bpW8kLs7zq2ZXgHptJHbKDDVx
You can now refer to the added file in a gateway, like so:
/ipfs/QmaG4FuMqEBnQNn3C8XJ5bpW8kLs7zq2ZXgHptJHbKDDVx/example.jpg
The chunker option, '-s', specifies the chunking strategy that dictates
how to break files into blocks. Blocks with same content can
be deduplicated. Different chunking strategies will produce different
hashes for the same file. The default is a fixed block size of
256 * 1024 bytes, 'size-262144'. Alternatively, you can use the
Buzhash or Rabin fingerprint chunker for content defined chunking by
specifying buzhash or rabin-[min]-[avg]-[max] (where min/avg/max refer
to the desired chunk sizes in bytes), e.g. 'rabin-262144-524288-1048576'.
The following examples use very small byte sizes to demonstrate the
properties of the different chunkers on a small file. You'll likely
want to use a 1024 times larger chunk sizes for most files.
> ipfs add --chunker=size-2048 ipfs-logo.svg
added QmafrLBfzRLV4XSH1XcaMMeaXEUhDJjmtDfsYU95TrWG87 ipfs-logo.svg
> ipfs add --chunker=rabin-512-1024-2048 ipfs-logo.svg
added Qmf1hDN65tR55Ubh2RN1FPxr69xq3giVBz1KApsresY8Gn ipfs-logo.svg
You can now check what blocks have been created by:
> ipfs object links QmafrLBfzRLV4XSH1XcaMMeaXEUhDJjmtDfsYU95TrWG87
QmY6yj1GsermExDXoosVE3aSPxdMNYr6aKuw3nA8LoWPRS 2059
Qmf7ZQeSxq2fJVJbCmgTrLLVN9tDR9Wy5k75DxQKuz5Gyt 1195
> ipfs object links Qmf1hDN65tR55Ubh2RN1FPxr69xq3giVBz1KApsresY8Gn
QmY6yj1GsermExDXoosVE3aSPxdMNYr6aKuw3nA8LoWPRS 2059
QmerURi9k4XzKCaaPbsK6BL5pMEjF7PGphjDvkkjDtsVf3 868
QmQB28iwSriSUSMqG2nXDTLtdPHgWb4rebBrU7Q1j4vxPv 338
Finally, a note on hash determinism. While not guaranteed, adding the same
file/directory with the same flags will almost always result in the same output
hash. However, almost all of the flags provided by this command (other than pin,
only-hash, and progress/status related flags) will change the final hash.
# ipfs bitswap
USAGE
ipfs bitswap - Interact with the bitswap agent.
SYNOPSIS
ipfs bitswap
SUBCOMMANDS
ipfs bitswap ledger <peer> - Show the current ledger for a peer.
ipfs bitswap reprovide - Trigger reprovider.
ipfs bitswap stat - Show some diagnostic information on the bitswap
agent.
ipfs bitswap wantlist - Show blocks currently on the wantlist.
For more information about each command, use:
'ipfs bitswap <subcmd> --help'
# ipfs bitswap ledger
USAGE
ipfs bitswap ledger <peer> - Show the current ledger for a peer.
SYNOPSIS
ipfs bitswap ledger [--] <peer>
ARGUMENTS
<peer> - The PeerID (B58) of the ledger to inspect.
DESCRIPTION
The Bitswap decision engine tracks the number of bytes exchanged between IPFS
nodes, and stores this information as a collection of ledgers. This command
prints the ledger associated with a given peer.
# ipfs bitswap reprovide
USAGE
ipfs bitswap reprovide - Trigger reprovider.
SYNOPSIS
ipfs bitswap reprovide
DESCRIPTION
Trigger reprovider to announce our data to network.
# ipfs bitswap stat
USAGE
ipfs bitswap stat - Show some diagnostic information on the bitswap agent.
SYNOPSIS
ipfs bitswap stat [--verbose | -v] [--human]
OPTIONS
-v, --verbose bool - Print extra information.
--human bool - Print sizes in human readable format (e.g., 1K 234M 2G).
# ipfs bitswap wantlist
USAGE
ipfs bitswap wantlist - Show blocks currently on the wantlist.
SYNOPSIS
ipfs bitswap wantlist [--peer=<peer> | -p]
OPTIONS
-p, --peer string - Specify which peer to show wantlist for. Default: self.
DESCRIPTION
Print out all blocks currently on the bitswap wantlist for the local peer.
# ipfs block
USAGE
ipfs block - Interact with raw IPFS blocks.
SYNOPSIS
ipfs block
DESCRIPTION
'ipfs block' is a plumbing command used to manipulate raw IPFS blocks.
Reads from stdin or writes to stdout, and <key> is a base58 encoded
multihash.
SUBCOMMANDS
ipfs block get <key> - Get a raw IPFS block.
ipfs block put <data>... - Store input as an IPFS block.
ipfs block rm <hash>... - Remove IPFS block(s).
ipfs block stat <key> - Print information of a raw IPFS block.
For more information about each command, use:
'ipfs block <subcmd> --help'
# ipfs block get
USAGE
ipfs block get <key> - Get a raw IPFS block.
SYNOPSIS
ipfs block get [--] <key>
ARGUMENTS
<key> - The base58 multihash of an existing block to get.
DESCRIPTION
'ipfs block get' is a plumbing command for retrieving raw IPFS blocks.
It outputs to stdout, and <key> is a base58 encoded multihash.
# ipfs block put
USAGE
ipfs block put <data>... - Store input as an IPFS block.
SYNOPSIS
ipfs block put [--format=<format> | -f] [--mhtype=<mhtype>] [--mhlen=<mhlen>]
[--pin] [--] <data>...
ARGUMENTS
<data>... - The data to be stored as an IPFS block.
OPTIONS
-f, --format string - cid format for blocks to be created with.
--mhtype string - multihash hash function. Default: sha2-256.
--mhlen int - multihash hash length. Default: -1.
--pin bool - pin added blocks recursively. Default: false.
DESCRIPTION
'ipfs block put' is a plumbing command for storing raw IPFS blocks.
It reads from stdin, and outputs the block's CID to stdout.
Unless specified, this command returns dag-pb CIDv0 CIDs. Setting 'mhtype' to anything
other than 'sha2-256' or format to anything other than 'v0' will result in CIDv1.
# ipfs block rm
USAGE
ipfs block rm <hash>... - Remove IPFS block(s).
SYNOPSIS
ipfs block rm [--force | -f] [--quiet | -q] [--] <hash>...
ARGUMENTS
<hash>... - Bash58 encoded multihash of block(s) to remove.
OPTIONS
-f, --force bool - Ignore nonexistent blocks.
-q, --quiet bool - Write minimal output.
DESCRIPTION
'ipfs block rm' is a plumbing command for removing raw ipfs blocks.
It takes a list of base58 encoded multihashes to remove.
# ipfs block stat
USAGE
ipfs block stat <key> - Print information of a raw IPFS block.
SYNOPSIS
ipfs block stat [--] <key>
ARGUMENTS
<key> - The base58 multihash of an existing block to stat.
DESCRIPTION
'ipfs block stat' is a plumbing command for retrieving information
on raw IPFS blocks. It outputs the following to stdout:
Key - the base58 encoded multihash
Size - the size of the block in bytes
# ipfs bootstrap
USAGE
ipfs bootstrap - Show or edit the list of bootstrap peers.
SYNOPSIS
ipfs bootstrap
DESCRIPTION
Running 'ipfs bootstrap' with no arguments will run 'ipfs bootstrap list'.
SECURITY WARNING:
The bootstrap command manipulates the "bootstrap list", which contains
the addresses of bootstrap nodes. These are the *trusted peers* from
which to learn about other peers in the network. Only edit this list
if you understand the risks of adding or removing nodes from this list.
SUBCOMMANDS
ipfs bootstrap add [<peer>]... - Add peers to the bootstrap list.
ipfs bootstrap list - Show peers in the bootstrap list.
ipfs bootstrap rm [<peer>]... - Remove peers from the bootstrap list.
For more information about each command, use:
'ipfs bootstrap <subcmd> --help'
# ipfs bootstrap add
USAGE
ipfs bootstrap add [<peer>]... - Add peers to the bootstrap list.
SYNOPSIS
ipfs bootstrap add [--default] [--] [<peer>...]
ARGUMENTS
[<peer>]... - A peer to add to the bootstrap list (in the format
'<multiaddr>/<peerID>')
OPTIONS
--default bool - Add default bootstrap nodes. (Deprecated, use 'default'
subcommand instead).
DESCRIPTION
Outputs a list of peers that were added (that weren't already
in the bootstrap list).
SECURITY WARNING:
The bootstrap command manipulates the "bootstrap list", which contains
the addresses of bootstrap nodes. These are the *trusted peers* from
which to learn about other peers in the network. Only edit this list
if you understand the risks of adding or removing nodes from this list.
SUBCOMMANDS
ipfs bootstrap add default - Add default peers to the bootstrap list.
For more information about each command, use:
'ipfs bootstrap add <subcmd> --help'
# ipfs bootstrap add default
USAGE
ipfs bootstrap add default - Add default peers to the bootstrap list.
SYNOPSIS
ipfs bootstrap add default
DESCRIPTION
Outputs a list of peers that were added (that weren't already
in the bootstrap list).
# ipfs bootstrap list
USAGE
ipfs bootstrap list - Show peers in the bootstrap list.
SYNOPSIS
ipfs bootstrap list
DESCRIPTION
Peers are output in the format '<multiaddr>/<peerID>'.
# ipfs bootstrap rm
USAGE
ipfs bootstrap rm [<peer>]... - Remove peers from the bootstrap list.
SYNOPSIS
ipfs bootstrap rm [--all] [--] [<peer>...]
ARGUMENTS
[<peer>]... - A peer to add to the bootstrap list (in the format
'<multiaddr>/<peerID>')
OPTIONS
--all bool - Remove all bootstrap peers. (Deprecated, use 'all' subcommand).
DESCRIPTION
Outputs the list of peers that were removed.
SECURITY WARNING:
The bootstrap command manipulates the "bootstrap list", which contains
the addresses of bootstrap nodes. These are the *trusted peers* from
which to learn about other peers in the network. Only edit this list
if you understand the risks of adding or removing nodes from this list.
SUBCOMMANDS
ipfs bootstrap rm all - Remove all peers from the bootstrap list.
For more information about each command, use:
'ipfs bootstrap rm <subcmd> --help'
# ipfs bootstrap rm all
USAGE
ipfs bootstrap rm all - Remove all peers from the bootstrap list.
SYNOPSIS
ipfs bootstrap rm all
DESCRIPTION
Outputs the list of peers that were removed.
# ipfs cat
USAGE
ipfs cat <ipfs-path>... - Show IPFS object data.
SYNOPSIS
ipfs cat [--offset=<offset> | -o] [--length=<length> | -l] [--] <ipfs-path>...
ARGUMENTS
<ipfs-path>... - The path to the IPFS object(s) to be outputted.
OPTIONS
-o, --offset int64 - Byte offset to begin reading from.
-l, --length int64 - Maximum number of bytes to read.
DESCRIPTION
Displays the data contained by an IPFS or IPNS object(s) at the given path.
# ipfs cid
USAGE
ipfs cid - Convert and discover properties of CIDs
SYNOPSIS
ipfs cid
SUBCOMMANDS
ipfs cid base32 <cid>... - Convert CIDs to Base32 CID version 1.
ipfs cid bases - List available multibase encodings.
ipfs cid codecs - List available CID codecs.
ipfs cid format <cid>... - Format and convert a CID in various useful ways.
ipfs cid hashes - List available multihashes.
For more information about each command, use:
'ipfs cid <subcmd> --help'
# ipfs cid base32
USAGE
ipfs cid base32 <cid>... - Convert CIDs to Base32 CID version 1.
SYNOPSIS
ipfs cid base32 [--] <cid>...
ARGUMENTS
<cid>... - Cids to convert.
# ipfs cid bases
USAGE
ipfs cid bases - List available multibase encodings.
SYNOPSIS
ipfs cid bases [--prefix] [--numeric]
OPTIONS
--prefix bool - also include the single letter prefixes in addition to the
code.
--numeric bool - also include numeric codes.
# ipfs cid codecs
USAGE
ipfs cid codecs - List available CID codecs.
SYNOPSIS
ipfs cid codecs [--numeric]
OPTIONS
--numeric bool - also include numeric codes.
# ipfs cid format
USAGE
ipfs cid format <cid>... - Format and convert a CID in various useful ways.
SYNOPSIS
ipfs cid format [-f=<f>] [-v=<v>] [--codec=<codec>] [-b=<b>] [--] <cid>...
ARGUMENTS
<cid>... - Cids to format.
OPTIONS
-f string - Printf style format string. Default: %s.
-v string - CID version to convert to.
--codec string - CID codec to convert to.
-b string - Multibase to display CID in.
DESCRIPTION
Format and converts <cid>'s in various useful ways.
The optional format string is a printf style format string:
%% literal %
%b multibase name
%B multibase code
%v version string
%V version number
%c codec name
%C codec code
%h multihash name
%H multihash code
%L hash digest length
%m multihash encoded in base %b (with multibase prefix)
%M multihash encoded in base %b without multibase prefix
%d hash digest encoded in base %b (with multibase prefix)
%D hash digest encoded in base %b without multibase prefix
%s cid string encoded in base %b (1)
%S cid string encoded in base %b without multibase prefix
%P cid prefix: %v-%c-%h-%L
(1) For CID version 0 the multibase must be base58btc and no prefix is
used. For Cid version 1 the multibase prefix is included.
# ipfs cid hashes
USAGE
ipfs cid hashes - List available multihashes.
SYNOPSIS
ipfs cid hashes [--numeric]
OPTIONS
--numeric bool - also include numeric codes.
# ipfs commands
USAGE
ipfs commands - List all available commands.
SYNOPSIS
ipfs commands [--flags | -f]
OPTIONS
-f, --flags bool - Show command flags.
DESCRIPTION
Lists all available commands (and subcommands) and exits.
# ipfs config
USAGE
ipfs config <key> [<value>] - Get and set ipfs config values.
SYNOPSIS
ipfs config [--bool] [--json] [--] <key> [<value>]
ARGUMENTS
<key> - The key of the config entry (e.g. "Addresses.API").
[<value>] - The value to set the config entry to.
OPTIONS
--bool bool - Set a boolean value.
--json bool - Parse stringified JSON.
DESCRIPTION
'ipfs config' controls configuration variables. It works
much like 'git config'. The configuration values are stored in a config
file inside your IPFS repository.
Examples:
Get the value of the 'Datastore.Path' key:
$ ipfs config Datastore.Path
Set the value of the 'Datastore.Path' key:
$ ipfs config Datastore.Path ~/.ipfs/datastore
SUBCOMMANDS
ipfs config edit - Open the config file for editing in $EDITOR.
ipfs config profile - Apply profiles to config.
ipfs config replace <file> - Replace the config with <file>.
ipfs config show - Output config file contents.
For more information about each command, use:
'ipfs config <subcmd> --help'
# ipfs config edit
USAGE
ipfs config edit - Open the config file for editing in $EDITOR.
SYNOPSIS
ipfs config edit
DESCRIPTION
To use 'ipfs config edit', you must have the $EDITOR environment
variable set to your preferred text editor.
# ipfs config profile
USAGE
ipfs config profile - Apply profiles to config.
SYNOPSIS
ipfs config profile
DESCRIPTION
Available profiles:
'server':
Disables local host discovery, recommended when
running IPFS on machines with public IPv4 addresses.
'local-discovery':
Sets default values to fields affected by the server
profile, enables discovery in local networks.
'test':
Reduces external interference of IPFS daemon, this
is useful when using the daemon in test environments.
'flatfs':
Configures the node to use the flatfs datastore.
This is the most battle-tested and reliable datastore, but it's significantly
slower than the badger datastore. You should use this datastore if:
* You need a very simple and very reliable datastore and you trust your
filesystem. This datastore stores each block as a separate file in the
underlying filesystem so it's unlikely to loose data unless there's an issue
with the underlying file system.
* You need to run garbage collection on a small (<= 10GiB) datastore. The
default datastore, badger, can leave several gigabytes of data behind when
garbage collecting.
* You're concerned about memory usage. In its default configuration, badger can
use up to several gigabytes of memory.
This profile may only be applied when first initializing the node.
'default-networking':
Restores default network settings.
Inverse profile of the test profile.
'default-datastore':
Configures the node to use the default datastore (flatfs).
Read the "flatfs" profile description for more information on this datastore.
This profile may only be applied when first initializing the node.
'badgerds':
Configures the node to use the badger datastore.
This is the fastest datastore. Use this datastore if performance, especially
when adding many gigabytes of files, is critical. However:
* This datastore will not properly reclaim space when your datastore is
smaller than several gigabytes. If you run IPFS with '--enable-gc' (you have
enabled block-level garbage collection), you plan on storing very little data in
your IPFS node, and disk usage is more critical than performance, consider using
flatfs.
* This datastore uses up to several gigabytes of memory.
This profile may only be applied when first initializing the node.
'lowpower':
Reduces daemon overhead on the system. May affect node
functionality - performance of content discovery and data
fetching may be degraded.
'randomports':
Use a random port number for swarm.
SUBCOMMANDS
ipfs config profile apply <profile> - Apply profile to config.
For more information about each command, use:
'ipfs config profile <subcmd> --help'
# ipfs config profile apply
USAGE
ipfs config profile apply <profile> - Apply profile to config.
SYNOPSIS
ipfs config profile apply [--dry-run] [--] <profile>
ARGUMENTS
<profile> - The profile to apply to the config.
OPTIONS
--dry-run bool - print difference between the current config and the config
that would be generated.
# ipfs config replace
USAGE
ipfs config replace <file> - Replace the config with <file>.
SYNOPSIS
ipfs config replace [--] <file>
ARGUMENTS
<file> - The file to use as the new config.
DESCRIPTION
Make sure to back up the config file first if necessary, as this operation
can't be undone.
# ipfs config show
USAGE
ipfs config show - Output config file contents.
SYNOPSIS
ipfs config show
DESCRIPTION
NOTE: For security reasons, this command will omit your private key and remote services. If you would like to make a full backup of your config (private key included), you must copy the config file from your repo.
# ipfs daemon
USAGE
ipfs daemon - Run a network-connected IPFS node.
SYNOPSIS
ipfs daemon [--init] [--init-config=<init-config>]
[--init-profile=<init-profile>] [--routing=<routing>] [--mount]
[--writable] [--mount-ipfs=<mount-ipfs>]
[--mount-ipns=<mount-ipns>] [--unrestricted-api]
[--disable-transport-encryption] [--enable-gc]
[--manage-fdlimit=false] [--migrate] [--enable-pubsub-experiment]
[--enable-namesys-pubsub] [--enable-mplex-experiment]
OPTIONS
--init bool - Initialize ipfs with default
settings if not already initialized.
--init-config string - Path to existing configuration file
to be loaded during --init.
--init-profile string - Configuration profiles to apply for
--init. See ipfs init --help for
more.
--routing string - Overrides the routing option.
Default: default.
--mount bool - Mounts IPFS to the filesystem.
--writable bool - Enable writing objects (with POST,
PUT and DELETE).
--mount-ipfs string - Path to the mountpoint for IPFS (if
using --mount). Defaults to config
setting.
--mount-ipns string - Path to the mountpoint for IPNS (if
using --mount). Defaults to config
setting.
--unrestricted-api bool - Allow API access to unlisted hashes.
--disable-transport-encryption bool - Disable transport encryption (for
debugging protocols).
--enable-gc bool - Enable automatic periodic repo
garbage collection.
--manage-fdlimit bool - Check and raise file descriptor
limits if needed. Default: true.
--migrate bool - If true, assume yes at the migrate
prompt. If false, assume no.
--enable-pubsub-experiment bool - Instantiate the ipfs daemon with the
experimental pubsub feature enabled.
--enable-namesys-pubsub bool - Enable IPNS record distribution
through pubsub; enables pubsub.
--enable-mplex-experiment bool - DEPRECATED.
DESCRIPTION
The daemon will start listening on ports on the network, which are
documented in (and can be modified through) 'ipfs config Addresses'.
For example, to change the 'Gateway' port:
ipfs config Addresses.Gateway /ip4/127.0.0.1/tcp/8082
The API address can be changed the same way:
ipfs config Addresses.API /ip4/127.0.0.1/tcp/5002
Make sure to restart the daemon after changing addresses.
By default, the gateway is only accessible locally. To expose it to
other computers in the network, use 0.0.0.0 as the ip address:
ipfs config Addresses.Gateway /ip4/0.0.0.0/tcp/8080
Be careful if you expose the API. It is a security risk, as anyone could
control your node remotely. If you need to control the node remotely,
make sure to protect the port as you would other services or database
(firewall, authenticated proxy, etc).
HTTP Headers
ipfs supports passing arbitrary headers to the API and Gateway. You can
do this by setting headers on the API.HTTPHeaders and Gateway.HTTPHeaders
keys:
ipfs config --json API.HTTPHeaders.X-Special-Header "[\"so special :)\"]"
ipfs config --json Gateway.HTTPHeaders.X-Special-Header "[\"so special :)\"]"
Note that the value of the keys is an _array_ of strings. This is because
headers can have more than one value, and it is convenient to pass through
to other libraries.
CORS Headers (for API)
You can setup CORS headers the same way:
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin "[\"example.com\"]"
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods "[\"PUT\", \"GET\", \"POST\"]"
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials "[\"true\"]"
Shutdown
To shut down the daemon, send a SIGINT signal to it (e.g. by pressing 'Ctrl-C')
or send a SIGTERM signal to it (e.g. with 'kill'). It may take a while for the
daemon to shutdown gracefully, but it can be killed forcibly by sending a
second signal.
IPFS_PATH environment variable
ipfs uses a repository in the local file system. By default, the repo is
located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
environment variable:
export IPFS_PATH=/path/to/ipfsrepo
Routing
IPFS by default will use a DHT for content routing. There is a highly
experimental alternative that operates the DHT in a 'client only' mode that
can be enabled by running the daemon as:
ipfs daemon --routing=dhtclient
This will later be transitioned into a config option once it gets out of the
'experimental' stage.
DEPRECATION NOTICE
Previously, ipfs used an environment variable as seen below:
export API_ORIGIN="http://localhost:8888/"
This is deprecated. It is still honored in this version, but will be removed
in a future version, along with this notice. Please move to setting the HTTP
Headers.
# ipfs dag
USAGE
ipfs dag - Interact with ipld dag objects.
SYNOPSIS
ipfs dag
DESCRIPTION
'ipfs dag' is used for creating and manipulating dag objects/hierarchies.
This subcommand is currently an experimental feature, but it is intended
to deprecate and replace the existing 'ipfs object' command moving forward.
SUBCOMMANDS
ipfs dag export <root> - Streams the selected DAG as a .car stream on
stdout.
ipfs dag get <ref> - Get a dag node from ipfs.
ipfs dag import <path>... - Import the contents of .car files
ipfs dag put <object data>... - Add a dag node to ipfs.
ipfs dag resolve <ref> - Resolve ipld block
ipfs dag stat <root> - Gets stats for a DAG
For more information about each command, use:
'ipfs dag <subcmd> --help'
# ipfs dag export
USAGE
ipfs dag export <root> - Streams the selected DAG as a .car stream on stdout.
SYNOPSIS
ipfs dag export [--progress | -p] [--] <root>
ARGUMENTS
<root> - CID of a root to recursively export
OPTIONS
-p, --progress bool - Display progress on CLI. Defaults to true when STDERR
is a TTY.
DESCRIPTION
'ipfs dag export' fetches a dag and streams it out as a well-formed .car file.
Note that at present only single root selections / .car files are supported.
The output of blocks happens in strict DAG-traversal, first-seen, order.
# ipfs dag get
USAGE
ipfs dag get <ref> - Get a dag node from ipfs.
SYNOPSIS
ipfs dag get [--] <ref>
ARGUMENTS
<ref> - The object to get
DESCRIPTION
'ipfs dag get' fetches a dag node from ipfs and prints it out in the specified
format.
# ipfs dag import
USAGE
ipfs dag import <path>... - Import the contents of .car files
SYNOPSIS
ipfs dag import [--silent] [--pin-roots=false] [--] <path>...
ARGUMENTS
<path>... - The path of a .car file.
OPTIONS
--silent bool - No output.
--pin-roots bool - Pin optional roots listed in the .car headers after
importing. Default: true.
DESCRIPTION
'ipfs dag import' imports all blocks present in supplied .car
( Content Address aRchive ) files, recursively pinning any roots
specified in the CAR file headers, unless --pin-roots is set to false.
Note:
This command will import all blocks in the CAR file, not just those
reachable from the specified roots. However, these other blocks will
not be pinned and may be garbage collected later.
The pinning of the roots happens after all car files are processed,
permitting import of DAGs spanning multiple files.
Pinning takes place in offline-mode exclusively, one root at a time.
If the combination of blocks from the imported CAR files and what is
currently present in the blockstore does not represent a complete DAG,
pinning of that individual root will fail.
Maximum supported CAR version: 1
# ipfs dag put
USAGE
ipfs dag put <object data>... - Add a dag node to ipfs.
SYNOPSIS
ipfs dag put [--format=<format> | -f] [--input-enc=<input-enc>] [--pin]
[--hash=<hash>] [--] <object data>...
ARGUMENTS
<object data>... - The object to put
OPTIONS
-f, --format string - Format that the object will be added as. Default: cbor.
--input-enc string - Format that the input object will be. Default: json.
--pin bool - Pin this object when adding.
--hash string - Hash function to use. Default: .
DESCRIPTION
'ipfs dag put' accepts input from a file or stdin and parses it
into an object of the specified format.
# ipfs dag resolve
USAGE
ipfs dag resolve <ref> - Resolve ipld block
SYNOPSIS
ipfs dag resolve [--] <ref>
ARGUMENTS
<ref> - The path to resolve
DESCRIPTION
'ipfs dag resolve' fetches a dag node from ipfs, prints its address and remaining path.
# ipfs dag stat
USAGE
ipfs dag stat <root> - Gets stats for a DAG
SYNOPSIS
ipfs dag stat [--progress=false] [--] <root>
ARGUMENTS
<root> - CID of a DAG root to get statistics for
OPTIONS
-p, --progress bool - Return progressive data while reading through the DAG.
Default: true.
DESCRIPTION
'ipfs dag stat' fetches a dag and returns various statistics about the DAG.
Statistics include size and number of blocks.
Note: This command skips duplicate blocks in reporting both size and the number of blocks
# ipfs dht
USAGE
ipfs dht - Issue commands directly through the DHT.
SYNOPSIS
ipfs dht
SUBCOMMANDS
ipfs dht findpeer <peerID>... - Find the multiaddresses associated with a
Peer ID.
ipfs dht findprovs <key>... - Find peers that can provide a specific
value, given a key.
ipfs dht get <key>... - Given a key, query the routing system for
its best value.
ipfs dht provide <key>... - Announce to the network that you are
providing given values.
ipfs dht put <key> <value-file> - Write a key/value pair to the routing
system.
ipfs dht query <peerID>... - Find the closest Peer IDs to a given Peer
ID by querying the DHT.
For more information about each command, use:
'ipfs dht <subcmd> --help'
# ipfs dht findpeer
USAGE
ipfs dht findpeer <peerID>... - Find the multiaddresses associated with a
Peer ID.
SYNOPSIS
ipfs dht findpeer [--verbose | -v] [--] <peerID>...
ARGUMENTS
<peerID>... - The ID of the peer to search for.
OPTIONS
-v, --verbose bool - Print extra information.
DESCRIPTION
Outputs a list of newline-delimited multiaddresses.
# ipfs dht findprovs
USAGE
ipfs dht findprovs <key>... - Find peers that can provide a specific value,
given a key.
SYNOPSIS
ipfs dht findprovs [--verbose | -v] [--num-providers=<num-providers> | -n]
[--] <key>...
ARGUMENTS
<key>... - The key to find providers for.
OPTIONS
-v, --verbose bool - Print extra information.
-n, --num-providers int - The number of providers to find. Default: 20.
DESCRIPTION
Outputs a list of newline-delimited provider Peer IDs.
# ipfs dht get
USAGE
ipfs dht get <key>... - Given a key, query the routing system for its best
value.
SYNOPSIS
ipfs dht get [--verbose | -v] [--] <key>...
ARGUMENTS
<key>... - The key to find a value for.
OPTIONS
-v, --verbose bool - Print extra information.
DESCRIPTION
Outputs the best value for the given key.
There may be several different values for a given key stored in the routing
system; in this context 'best' means the record that is most desirable. There is
no one metric for 'best': it depends entirely on the key type. For IPNS, 'best'
is the record that is both valid and has the highest sequence number (freshest).
Different key types can specify other 'best' rules.
# ipfs dht provide
USAGE
ipfs dht provide <key>... - Announce to the network that you are providing
given values.
SYNOPSIS
ipfs dht provide [--verbose | -v] [--recursive | -r] [--] <key>...
ARGUMENTS
<key>... - The key[s] to send provide records for.
OPTIONS
-v, --verbose bool - Print extra information.
-r, --recursive bool - Recursively provide entire graph.
# ipfs dht put
USAGE
ipfs dht put <key> <value-file> - Write a key/value pair to the routing
system.
SYNOPSIS
ipfs dht put [--verbose | -v] [--] <key> <value-file>
ARGUMENTS
<key> - The key to store the value at.
<value-file> - A path to a file containing the value to store.
OPTIONS
-v, --verbose bool - Print extra information.
DESCRIPTION
Given a key of the form /foo/bar and a valid value for that key, this will write
that value to the routing system with that key.
Keys have two parts: a keytype (foo) and the key name (bar). IPNS uses the
/ipns keytype, and expects the key name to be a Peer ID. IPNS entries are
specifically formatted (protocol buffer).
You may only use keytypes that are supported in your ipfs binary: currently
this is only /ipns. Unless you have a relatively deep understanding of the
go-ipfs routing internals, you likely want to be using 'ipfs name publish' instead
of this.
The value must be a valid value for the given key type. For example, if the key
is /ipns/QmFoo, the value must be IPNS record (protobuf) signed with the key
identified by QmFoo.
# ipfs dht query
USAGE
ipfs dht query <peerID>... - Find the closest Peer IDs to a given Peer ID by
querying the DHT.
SYNOPSIS
ipfs dht query [--verbose | -v] [--] <peerID>...
ARGUMENTS
<peerID>... - The peerID to run the query against.
OPTIONS
-v, --verbose bool - Print extra information.
DESCRIPTION
Outputs a list of newline-delimited Peer IDs.
# ipfs diag
USAGE
ipfs diag - Generate diagnostic reports.
SYNOPSIS
ipfs diag
SUBCOMMANDS
ipfs diag cmds - List commands run on this IPFS node.
ipfs diag sys - Print system diagnostic information.
For more information about each command, use:
'ipfs diag <subcmd> --help'
# ipfs diag cmds
USAGE
ipfs diag cmds - List commands run on this IPFS node.
SYNOPSIS
ipfs diag cmds [--verbose | -v]
OPTIONS
-v, --verbose bool - Print extra information.
DESCRIPTION
Lists running and recently run commands.
SUBCOMMANDS
ipfs diag cmds clear - Clear inactive requests from the log.
ipfs diag cmds set-time <time> - Set how long to keep inactive requests in
the log.
For more information about each command, use:
'ipfs diag cmds <subcmd> --help'
# ipfs diag cmds clear
USAGE
ipfs diag cmds clear - Clear inactive requests from the log.
SYNOPSIS
ipfs diag cmds clear
# ipfs diag cmds set-time
USAGE
ipfs diag cmds set-time <time> - Set how long to keep inactive requests in
the log.
SYNOPSIS
ipfs diag cmds set-time [--] <time>
ARGUMENTS
<time> - Time to keep inactive requests in log.
# ipfs diag sys
USAGE
ipfs diag sys - Print system diagnostic information.
SYNOPSIS
ipfs diag sys
DESCRIPTION
Prints out information about your computer to aid in easier debugging.
# ipfs dns
USAGE
ipfs dns <domain-name> - Resolve DNS links.
SYNOPSIS
ipfs dns [--recursive=false] [--] <domain-name>
ARGUMENTS
<domain-name> - The domain-name name to resolve.
OPTIONS
-r, --recursive bool - Resolve until the result is not a DNS link. Default:
true.
DESCRIPTION
Multihashes are hard to remember, but domain names are usually easy to
remember. To create memorable aliases for multihashes, DNS TXT
records can point to other DNS links, IPFS objects, IPNS keys, etc.
This command resolves those links to the referenced object.
Note: This command can only recursively resolve DNS links,
it will fail to recursively resolve through IPNS keys etc.
For general-purpose recursive resolution, use ipfs name resolve -r.
For example, with this DNS TXT record:
> dig +short TXT _dnslink.ipfs.io
dnslink=/ipfs/QmRzTuh2Lpuz7Gr39stNr6mTFdqAghsZec1JoUnfySUzcy
The resolver will give:
> ipfs dns ipfs.io
/ipfs/QmRzTuh2Lpuz7Gr39stNr6mTFdqAghsZec1JoUnfySUzcy
The resolver can recursively resolve:
> dig +short TXT recursive.ipfs.io
dnslink=/ipns/ipfs.io
> ipfs dns -r recursive.ipfs.io
/ipfs/QmRzTuh2Lpuz7Gr39stNr6mTFdqAghsZec1JoUnfySUzcy
# ipfs file
USAGE
ipfs file - Interact with IPFS objects representing Unix filesystems.
SYNOPSIS
ipfs file
DESCRIPTION
'ipfs file' provides a familiar interface to file systems represented
by IPFS objects, which hides ipfs implementation details like layout
objects (e.g. fanout and chunking).
SUBCOMMANDS
ipfs file ls <ipfs-path>... - List directory contents for Unix filesystem
objects. Deprecated: Use 'ipfs ls' instead.
For more information about each command, use:
'ipfs file <subcmd> --help'
# ipfs file ls
USAGE
ipfs file ls <ipfs-path>... - List directory contents for Unix filesystem
objects. Deprecated: Use 'ipfs ls' instead.
SYNOPSIS
ipfs file ls [--] <ipfs-path>...
ARGUMENTS
<ipfs-path>... - The path to the IPFS object(s) to list links from.
DESCRIPTION
Displays the contents of an IPFS or IPNS object(s) at the given path.
The JSON output contains size information. For files, the child size
is the total size of the file contents. For directories, the child
size is the IPFS link size.
The path can be a prefixless ref; in this case, we assume it to be an
/ipfs ref and not /ipns.
Example:
> ipfs file ls QmW2WQi7j6c7UgJTarActp7tDNikE4B2qXtFCfLPdsgaTQ
cat.jpg
> ipfs file ls /ipfs/QmW2WQi7j6c7UgJTarActp7tDNikE4B2qXtFCfLPdsgaTQ
cat.jpg
This functionality is deprecated, and will be removed in future versions as it duplicates the functionality of 'ipfs ls'.
If possible, please use 'ipfs ls' instead.
# ipfs files
USAGE
ipfs files - Interact with unixfs files.
SYNOPSIS
ipfs files [--flush=false]
OPTIONS
-f, --flush bool - Flush target and ancestors after write. Default: true.
DESCRIPTION
Files is an API for manipulating IPFS objects as if they were a Unix
filesystem.
The files facility interacts with MFS (Mutable File System). MFS acts as a
single, dynamic filesystem mount. MFS has a root CID that is transparently
updated when a change happens (and can be checked with "ipfs files stat /").
All files and folders within MFS are respected and will not be cleaned up
during garbage collections. MFS is independent from the list of pinned items
("ipfs pin ls"). Calls to "ipfs pin add" and "ipfs pin rm" will add and remove
pins independently of MFS. If MFS content that was
additionally pinned is removed by calling "ipfs files rm", it will still
remain pinned.
Content added with "ipfs add" (which by default also becomes pinned), is not
added to MFS. Any content can be put into MFS with the command "ipfs files cp
/ipfs/<cid> /some/path/".
NOTE:
Most of the subcommands of 'ipfs files' accept the '--flush' flag. It defaults
to true. Use caution when setting this flag to false. It will improve
performance for large numbers of file operations, but it does so at the cost
of consistency guarantees. If the daemon is unexpectedly killed before running
'ipfs files flush' on the files in question, then data may be lost. This also
applies to run 'ipfs repo gc' concurrently with '--flush=false'
operations.
SUBCOMMANDS
ipfs files chcid [<path>] - Change the cid version or hash function of
the root node of a given path.
ipfs files cp <source> <dest> - Copy any IPFS files and directories into MFS
(or copy within MFS).
ipfs files flush [<path>] - Flush a given path's data to disk.
ipfs files ls [<path>] - List directories in the local mutable
namespace.
ipfs files mkdir <path> - Make directories.
ipfs files mv <source> <dest> - Move files.
ipfs files read <path> - Read a file in a given MFS.
ipfs files rm <path>... - Remove a file.
ipfs files stat <path> - Display file status.
ipfs files write <path> <data> - Write to a mutable file in a given
filesystem.
For more information about each command, use:
'ipfs files <subcmd> --help'
# ipfs files chcid
USAGE
ipfs files chcid [<path>] - Change the cid version or hash function of the
root node of a given path.
SYNOPSIS
ipfs files chcid [--cid-version=<cid-version> | --cid-ver] [--hash=<hash>]
[--] [<path>]
ARGUMENTS
[<path>] - Path to change. Default: '/'.
OPTIONS
--cid-ver, --cid-version int - Cid version to use. (experimental).
--hash string - Hash function to use. Will set Cid version
to 1 if used. (experimental).
DESCRIPTION
Change the cid version or hash function of the root node of a given path.
# ipfs files cp
USAGE
ipfs files cp <source> <dest> - Copy any IPFS files and directories into MFS
(or copy within MFS).
SYNOPSIS
ipfs files cp [--] <source> <dest>
ARGUMENTS
<source> - Source IPFS or MFS path to copy.
<dest> - Destination within MFS.
DESCRIPTION
"ipfs files cp" can be used to copy any IPFS file or directory (usually in the
form /ipfs/<CID>, but also any resolvable path), into the Mutable File System
(MFS).
It can also be used to copy files within MFS, but in the case when an
IPFS-path matches an existing MFS path, the IPFS path wins.
In order to add content to MFS from disk, you can use "ipfs add" to obtain the
IPFS Content Identifier and then "ipfs files cp" to copy it into MFS:
$ ipfs add --quieter --pin=false <your file>
# ...
# ... outputs the root CID at the end
$ ipfs cp /ipfs/<CID> /your/desired/mfs/path
# ipfs files flush
USAGE
ipfs files flush [<path>] - Flush a given path's data to disk.
SYNOPSIS
ipfs files flush [--] [<path>]
ARGUMENTS
[<path>] - Path to flush. Default: '/'.
DESCRIPTION
Flush a given path to the disk. This is only useful when other commands
are run with the '--flush=false'.
# ipfs files ls
USAGE
ipfs files ls [<path>] - List directories in the local mutable namespace.
SYNOPSIS
ipfs files ls [--long | -l] [-U] [--] [<path>]
ARGUMENTS
[<path>] - Path to show listing for. Defaults to '/'.
OPTIONS
-l, --long bool - Use long listing format.
-U bool - Do not sort; list entries in directory order.
DESCRIPTION
List directories in the local mutable namespace (works on both IPFS and MFS paths).
Examples:
$ ipfs files ls /welcome/docs/
about
contact
help
quick-start
readme
security-notes
$ ipfs files ls /myfiles/a/b/c/d
foo
bar
# ipfs files mkdir
USAGE
ipfs files mkdir <path> - Make directories.
SYNOPSIS
ipfs files mkdir [--parents | -p] [--cid-version=<cid-version> | --cid-ver]
[--hash=<hash>] [--] <path>
ARGUMENTS
<path> - Path to dir to make.
OPTIONS
-p, --parents bool - No error if existing, make parent
directories as needed.
--cid-ver, --cid-version int - Cid version to use. (experimental).
--hash string - Hash function to use. Will set Cid version
to 1 if used. (experimental).
DESCRIPTION
Create the directory if it does not already exist.
The directory will have the same CID version and hash function of the
parent directory unless the --cid-version and --hash options are used.
NOTE: All paths must be absolute.
Examples:
$ ipfs files mkdir /test/newdir
$ ipfs files mkdir -p /test/does/not/exist/yet
# ipfs files mv
USAGE
ipfs files mv <source> <dest> - Move files.
SYNOPSIS
ipfs files mv [--] <source> <dest>
ARGUMENTS
<source> - Source file to move.
<dest> - Destination path for file to be moved to.
DESCRIPTION
Move files around. Just like the traditional Unix mv.
Example:
$ ipfs files mv /myfs/a/b/c /myfs/foo/newc
# ipfs files read
USAGE
ipfs files read <path> - Read a file in a given MFS.
SYNOPSIS
ipfs files read [--offset=<offset> | -o] [--count=<count> | -n] [--] <path>
ARGUMENTS
<path> - Path to file to be read.
OPTIONS
-o, --offset int64 - Byte offset to begin reading from.
-n, --count int64 - Maximum number of bytes to read.
DESCRIPTION
Read a specified number of bytes from a file at a given offset. By default,
it will read the entire file similar to the Unix cat.
Examples:
$ ipfs files read /test/hello
hello
# ipfs files rm
USAGE
ipfs files rm <path>... - Remove a file.
SYNOPSIS
ipfs files rm [--recursive | -r] [--force] [--] <path>...
ARGUMENTS
<path>... - File to remove.
OPTIONS
-r, --recursive bool - Recursively remove directories.
--force bool - Forcibly remove target at path; implies -r for
directories.
DESCRIPTION
Remove files or directories.
$ ipfs files rm /foo
$ ipfs files ls /bar
cat
dog
fish
$ ipfs files rm -r /bar
# ipfs files stat
USAGE
ipfs files stat <path> - Display file status.
SYNOPSIS
ipfs files stat [--format=<format>] [--hash] [--size] [--with-local] [--]
<path>
ARGUMENTS
<path> - Path to node to stat.
OPTIONS
--format string - Print statistics in given format. Allowed tokens:
<hash> <size> <cumulsize> <type> <childs>. Conflicts
with other format options. Default: <hash>
Size:
<size>
CumulativeSize: <cumulsize>
ChildBlocks:
<childs>
Type: <type>.
--hash bool - Print only hash. Implies '--format=<hash>'. Conflicts
with other format options.
--size bool - Print only size. Implies '--format=<cumulsize>'.
Conflicts with other format options.
--with-local bool - Compute the amount of the dag that is local, and if
possible the total size.
# ipfs files write
USAGE
ipfs files write <path> <data> - Write to a mutable file in a given
filesystem.
SYNOPSIS
ipfs files write [--offset=<offset> | -o] [--create | -e] [--parents | -p]
[--truncate | -t] [--count=<count> | -n] [--raw-leaves]
[--cid-version=<cid-version> | --cid-ver] [--hash=<hash>]
[--] <path> <data>
ARGUMENTS
<path> - Path to write to.
<data> - Data to write.
OPTIONS
-o, --offset int64 - Byte offset to begin writing at.
-e, --create bool - Create the file if it does not exist.
-p, --parents bool - Make parent directories as needed.
-t, --truncate bool - Truncate the file to size zero before
writing.
-n, --count int64 - Maximum number of bytes to read.
--raw-leaves bool - Use raw blocks for newly created leaf
nodes. (experimental).
--cid-ver, --cid-version int - Cid version to use. (experimental).
--hash string - Hash function to use. Will set Cid version
to 1 if used. (experimental).
DESCRIPTION
Write data to a file in a given filesystem. This command allows you to specify
a beginning offset to write to. The entire length of the input will be
written.
If the '--create' option is specified, the file will be created if it does not
exist. Nonexistent intermediate directories will not be created unless the
'--parents' option is specified.
Newly created files will have the same CID version and hash function of the
parent directory unless the '--cid-version' and '--hash' options are used.
Newly created leaves will be in the legacy format (Protobuf) if the
CID version is 0, or raw if the CID version is non-zero. Use of the
'--raw-leaves' option will override this behavior.
If the '--flush' option is set to false, changes will not be propagated to the
merkledag root. This can make operations much faster when doing a large number
of writes to a deeper directory structure.
EXAMPLE:
echo "hello world" | ipfs files write --create --parents /myfs/a/b/file
echo "hello world" | ipfs files write --truncate /myfs/a/b/file
WARNING:
Usage of the '--flush=false' option does not guarantee data durability until
the tree has been flushed. This can be accomplished by running 'ipfs files
stat' on the file or any of its ancestors.
# ipfs filestore
USAGE
ipfs filestore - Interact with filestore objects.
SYNOPSIS
ipfs filestore
SUBCOMMANDS
ipfs filestore dups - List blocks that are both in the filestore
and standard block storage.
ipfs filestore ls [<obj>]... - List objects in filestore.
ipfs filestore verify [<obj>]... - Verify objects in filestore.
For more information about each command, use:
'ipfs filestore <subcmd> --help'
# ipfs filestore dups
USAGE
ipfs filestore dups - List blocks that are both in the filestore and standard
block storage.
SYNOPSIS
ipfs filestore dups
# ipfs filestore ls
USAGE
ipfs filestore ls [<obj>]... - List objects in filestore.
SYNOPSIS
ipfs filestore ls [--file-order] [--] [<obj>...]
ARGUMENTS
[<obj>]... - Cid of objects to list.
OPTIONS
--file-order bool - sort the results based on the path of the backing file.
DESCRIPTION
List objects in the filestore.
If one or more <obj> is specified only list those specific objects,
otherwise list all objects.
The output is:
<hash> <size> <path> <offset>
# ipfs filestore verify
USAGE
ipfs filestore verify [<obj>]... - Verify objects in filestore.
SYNOPSIS
ipfs filestore verify [--file-order] [--] [<obj>...]
ARGUMENTS
[<obj>]... - Cid of objects to verify.
OPTIONS
--file-order bool - verify the objects based on the order of the backing
file.
DESCRIPTION
Verify objects in the filestore.
If one or more <obj> is specified only verify those specific objects,
otherwise verify all objects.
The output is:
<status> <hash> <size> <path> <offset>
Where <status> is one of:
ok: the block can be reconstructed
changed: the contents of the backing file have changed
no-file: the backing file could not be found
error: there was some other problem reading the file
missing: <obj> could not be found in the filestore
ERROR: internal error, most likely due to a corrupt database
For ERROR entries the error will also be printed to stderr.
# ipfs get
USAGE
ipfs get <ipfs-path> - Download IPFS objects.
SYNOPSIS
ipfs get [--output=<output> | -o] [--archive | -a] [--compress | -C]
[--compression-level=<compression-level> | -l] [--] <ipfs-path>
ARGUMENTS
<ipfs-path> - The path to the IPFS object(s) to be outputted.
OPTIONS
-o, --output string - The path where the output should be stored.
-a, --archive bool - Output a TAR archive.
-C, --compress bool - Compress the output with GZIP compression.
-l, --compression-level int - The level of compression (1-9).
DESCRIPTION
Stores to disk the data contained an IPFS or IPNS object(s) at the given path.
By default, the output will be stored at './<ipfs-path>', but an alternate
path can be specified with '--output=<path>' or '-o=<path>'.
To output a TAR archive instead of unpacked files, use '--archive' or '-a'.
To compress the output with GZIP compression, use '--compress' or '-C'. You
may also specify the level of compression by specifying '-l=<1-9>'.
# ipfs id
USAGE
ipfs id [<peerid>] - Show ipfs node id info.
SYNOPSIS
ipfs id [--format=<format> | -f] [--peerid-base=<peerid-base>] [--] [<peerid>]
ARGUMENTS
[<peerid>] - Peer.ID of node to look up.
OPTIONS
-f, --format string - Optional output format.
--peerid-base string - Encoding used for peer IDs: Can either be a multibase
encoded CID or a base58btc encoded multihash. Takes
{b58mh|base36|k|base32|b...}. Default: b58mh.
DESCRIPTION
Prints out information about the specified peer.
If no peer is specified, prints out information for local peers.
'ipfs id' supports the format option for output with the following keys:
<id> : The peers id.
<aver>: Agent version.
<pver>: Protocol version.
<pubkey>: Public key.
<addrs>: Addresses (newline delimited).
EXAMPLE:
ipfs id Qmece2RkXhsKe5CRooNisBTh4SK119KrXXGmoK6V3kb8aH -f="<addrs>\n"
# ipfs init
USAGE
ipfs init [<default-config>] - Initializes ipfs config file.
SYNOPSIS
ipfs init [--algorithm=<algorithm> | -a] [--bits=<bits> | -b]
[--empty-repo | -e] [--profile=<profile> | -p] [--]
[<default-config>]
ARGUMENTS
[<default-config>] - Initialize with the given configuration.
OPTIONS
-a, --algorithm string - Cryptographic algorithm to use for key generation.
Default: ed25519.
-b, --bits int - Number of bits to use in the generated RSA private
key.
-e, --empty-repo bool - Don't add and pin help files to the local storage.
-p, --profile string - Apply profile settings to config. Multiple
profiles can be separated by ','.
DESCRIPTION
Initializes ipfs configuration files and generates a new keypair.
If you are going to run IPFS in server environment, you may want to
initialize it using 'server' profile.
For the list of available profiles see 'ipfs config profile --help'
ipfs uses a repository in the local file system. By default, the repo is
located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
environment variable:
export IPFS_PATH=/path/to/ipfsrepo
# ipfs key
USAGE
ipfs key - Create and list IPNS name keypairs
SYNOPSIS
ipfs key
DESCRIPTION
'ipfs key gen' generates a new keypair for usage with IPNS and 'ipfs name
publish'.
> ipfs key gen --type=rsa --size=2048 mykey
> ipfs name publish --key=mykey QmSomeHash
'ipfs key list' lists the available keys.
> ipfs key list
self
mykey
SUBCOMMANDS
ipfs key export <name> - Export a keypair
ipfs key gen <name> - Create a new keypair
ipfs key import <name> <key> - Import a key and prints imported key id
ipfs key list - List all local keypairs
ipfs key rename <name> <newName> - Rename a keypair
ipfs key rm <name>... - Remove a keypair
ipfs key rotate - Rotates the ipfs identity.
For more information about each command, use:
'ipfs key <subcmd> --help'
# ipfs key export
USAGE
ipfs key export <name> - Export a keypair
SYNOPSIS
ipfs key export [--output=<output> | -o] [--] <name>
ARGUMENTS
<name> - name of key to export
OPTIONS
-o, --output string - The path where the output should be stored.
DESCRIPTION
Exports a named libp2p key to disk.
By default, the output will be stored at './<key-name>.key', but an alternate
path can be specified with '--output=<path>' or '-o=<path>'.
# ipfs key gen
USAGE
ipfs key gen <name> - Create a new keypair
SYNOPSIS
ipfs key gen [--type=<type> | -t] [--size=<size> | -s]
[--ipns-base=<ipns-base>] [--] <name>
ARGUMENTS
<name> - name of key to create
OPTIONS
-t, --type string - type of the key to create: rsa, ed25519. Default:
ed25519.
-s, --size int - size of the key to generate.
--ipns-base string - Encoding used for keys: Can either be a multibase
encoded CID or a base58btc encoded multihash. Takes
{b58mh|base36|k|base32|b...}. Default: base36.
# ipfs key import
USAGE
ipfs key import <name> <key> - Import a key and prints imported key id
SYNOPSIS
ipfs key import [--ipns-base=<ipns-base>] [--] <name> <key>
ARGUMENTS
<name> - name to associate with key in keychain
<key> - key provided by generate or export
OPTIONS
--ipns-base string - Encoding used for keys: Can either be a multibase
encoded CID or a base58btc encoded multihash. Takes
{b58mh|base36|k|base32|b...}. Default: base36.
# ipfs key list
USAGE
ipfs key list - List all local keypairs
SYNOPSIS
ipfs key list [-l] [--ipns-base=<ipns-base>]
OPTIONS
-l bool - Show extra information about keys.
--ipns-base string - Encoding used for keys: Can either be a multibase
encoded CID or a base58btc encoded multihash. Takes
{b58mh|base36|k|base32|b...}. Default: base36.
# ipfs key rename
USAGE
ipfs key rename <name> <newName> - Rename a keypair
SYNOPSIS
ipfs key rename [--force | -f] [--ipns-base=<ipns-base>] [--] <name> <newName>
ARGUMENTS
<name> - name of key to rename
<newName> - new name of the key
OPTIONS
-f, --force bool - Allow to overwrite an existing key.
--ipns-base string - Encoding used for keys: Can either be a multibase
encoded CID or a base58btc encoded multihash. Takes
{b58mh|base36|k|base32|b...}. Default: base36.
# ipfs key rm
USAGE
ipfs key rm <name>... - Remove a keypair
SYNOPSIS
ipfs key rm [-l] [--ipns-base=<ipns-base>] [--] <name>...
ARGUMENTS
<name>... - names of keys to remove
OPTIONS
-l bool - Show extra information about keys.
--ipns-base string - Encoding used for keys: Can either be a multibase
encoded CID or a base58btc encoded multihash. Takes
{b58mh|base36|k|base32|b...}. Default: base36.
# ipfs key rotate
USAGE
ipfs key rotate - Rotates the ipfs identity.
SYNOPSIS
ipfs key rotate [--oldkey=<oldkey> | -o] [--type=<type> | -t]
[--size=<size> | -s]
OPTIONS
-o, --oldkey string - Keystore name to use for backing up your existing
identity.
-t, --type string - type of the key to create: rsa, ed25519. Default:
ed25519.
-s, --size int - size of the key to generate.
DESCRIPTION
Generates a new ipfs identity and saves it to the ipfs config file.
Your existing identity key will be backed up in the Keystore.
The daemon must not be running when calling this command.
ipfs uses a repository in the local file system. By default, the repo is
located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
environment variable:
export IPFS_PATH=/path/to/ipfsrepo
# ipfs log
USAGE
ipfs log - Interact with the daemon log output.
SYNOPSIS
ipfs log
DESCRIPTION
'ipfs log' contains utility commands to affect or read the logging
output of a running daemon.
There are also two environmental variables that direct the logging
system (not just for the daemon logs, but all commands):
IPFS_LOGGING - sets the level of verbosity of the logging.
One of: debug, info, warn, error, dpanic, panic, fatal
IPFS_LOGGING_FMT - sets formatting of the log output.
One of: color, nocolor
SUBCOMMANDS
ipfs log level <subsystem> <level> - Change the logging level.
ipfs log ls - List the logging subsystems.
ipfs log tail - Read the event log.
For more information about each command, use:
'ipfs log <subcmd> --help'
# ipfs log level
USAGE
ipfs log level <subsystem> <level> - Change the logging level.
SYNOPSIS
ipfs log level [--] <subsystem> <level>
ARGUMENTS
<subsystem> - The subsystem logging identifier. Use 'all' for all subsystems.
<level> - The log level, with 'debug' the most verbose and 'fatal' the
least verbose.
One of: debug, info, warn, error, dpanic,
panic, fatal.
DESCRIPTION
Change the verbosity of one or all subsystems log output. This does not affect
the event log.
# ipfs log ls
USAGE
ipfs log ls - List the logging subsystems.
SYNOPSIS
ipfs log ls
DESCRIPTION
'ipfs log ls' is a utility command used to list the logging
subsystems of a running daemon.
# ipfs log tail
USAGE
ipfs log tail - Read the event log.
SYNOPSIS
ipfs log tail
DESCRIPTION
Outputs event log messages (not other log messages) as they are generated.
# ipfs ls
USAGE
ipfs ls <ipfs-path>... - List directory contents for Unix filesystem objects.
SYNOPSIS
ipfs ls [--headers | -v] [--resolve-type=false] [--size=false] [--stream | -s]
[--] <ipfs-path>...
ARGUMENTS
<ipfs-path>... - The path to the IPFS object(s) to list links from.
OPTIONS
-v, --headers bool - Print table headers (Hash, Size, Name).
--resolve-type bool - Resolve linked objects to find out their types.
Default: true.
--size bool - Resolve linked objects to find out their file size.
Default: true.
-s, --stream bool - Enable experimental streaming of directory entries as
they are traversed.
DESCRIPTION
Displays the contents of an IPFS or IPNS object(s) at the given path, with
the following format:
<link base58 hash> <link size in bytes> <link name>
The JSON output contains type information.
# ipfs mount
USAGE
ipfs mount - Mounts IPFS to the filesystem (read-only).
SYNOPSIS
ipfs mount [--ipfs-path=<ipfs-path> | -f] [--ipns-path=<ipns-path> | -n]
OPTIONS
-f, --ipfs-path string - The path where IPFS should be mounted.
-n, --ipns-path string - The path where IPNS should be mounted.
DESCRIPTION
Mount IPFS at a read-only mountpoint on the OS. The default, /ipfs and /ipns,
are set in the configuration file, but can be overridden by the options.
All IPFS objects will be accessible under this directory. Note that the
root will not be listable, as it is virtual. Access known paths directly.
You may have to create /ipfs and /ipns before using 'ipfs mount':
> sudo mkdir /ipfs /ipns
> sudo chown $(whoami) /ipfs /ipns
> ipfs daemon &
> ipfs mount
Example:
# setup
> mkdir foo
> echo "baz" > foo/bar
> ipfs add -r foo
added QmWLdkp93sNxGRjnFHPaYg8tCQ35NBY3XPn6KiETd3Z4WR foo/bar
added QmSh5e7S6fdcu75LAbXNZAFY2nGyZUJXyLCJDvn2zRkWyC foo
> ipfs ls QmSh5e7S6fdcu75LAbXNZAFY2nGyZUJXyLCJDvn2zRkWyC
QmWLdkp93sNxGRjnFHPaYg8tCQ35NBY3XPn6KiETd3Z4WR 12 bar
> ipfs cat QmWLdkp93sNxGRjnFHPaYg8tCQ35NBY3XPn6KiETd3Z4WR
baz
# mount
> ipfs daemon &
> ipfs mount
IPFS mounted at: /ipfs
IPNS mounted at: /ipns
> cd /ipfs/QmSh5e7S6fdcu75LAbXNZAFY2nGyZUJXyLCJDvn2zRkWyC
> ls
bar
> cat bar
baz
> cat /ipfs/QmSh5e7S6fdcu75LAbXNZAFY2nGyZUJXyLCJDvn2zRkWyC/bar
baz
> cat /ipfs/QmWLdkp93sNxGRjnFHPaYg8tCQ35NBY3XPn6KiETd3Z4WR
baz
# ipfs name
USAGE
ipfs name - Publish and resolve IPNS names.
SYNOPSIS
ipfs name
DESCRIPTION
IPNS is a PKI namespace, where names are the hashes of public keys, and
the private key enables publishing new (signed) values. In both publish
and resolve, the default name used is the node's own PeerID,
which is the hash of its public key.
You can use the 'ipfs key' commands to list and generate more names and their
respective keys.
Examples:
Publish an <ipfs-path> with your default name:
> ipfs name publish /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Publish an <ipfs-path> with another name, added by an 'ipfs key' command:
> ipfs key gen --type=rsa --size=2048 mykey
> ipfs name publish --key=mykey /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Published to QmSrPmbaUKA3ZodhzPWZnpFgcPMFWF4QsxXbkWfEptTBJd: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Resolve the value of your name:
> ipfs name resolve
/ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Resolve the value of another name:
> ipfs name resolve QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
/ipfs/QmSiTko9JZyabH56y2fussEt1A5oDqsFXB3CkvAqraFryz
Resolve the value of a dnslink:
> ipfs name resolve ipfs.io
/ipfs/QmaBvfZooxWkrv7D3r8LS9moNjzD2o525XMZze69hhoxf5
SUBCOMMANDS
ipfs name publish <ipfs-path> - Publish IPNS names.
ipfs name pubsub - IPNS pubsub management
ipfs name resolve [<name>] - Resolve IPNS names.
For more information about each command, use:
'ipfs name <subcmd> --help'
# ipfs name publish
USAGE
ipfs name publish <ipfs-path> - Publish IPNS names.
SYNOPSIS
ipfs name publish [--resolve=false] [--lifetime=<lifetime> | -t]
[--allow-offline] [--ttl=<ttl>] [--key=<key> | -k]
[--quieter | -Q] [--ipns-base=<ipns-base>] [--] <ipfs-path>
ARGUMENTS
<ipfs-path> - ipfs path of the object to be published.
OPTIONS
--resolve bool - Check if the given path can be resolved before
publishing. Default: true.
-t, --lifetime string - Time duration that the record will be valid for.
Default: 24h.
This accepts durations such as
"300s", "1.5h" or "2h45m". Valid time units are
"ns", "us" (or "µs"), "ms", "s", "m", "h".
--allow-offline bool - When offline, save the IPNS record to the the local
datastore without broadcasting to the network
instead of simply failing.
--ttl string - Time duration this record should be cached for.
Uses the same syntax as the lifetime option.
(caution: experimental).
-k, --key string - Name of the key to be used or a valid PeerID, as
listed by 'ipfs key list -l'. Default: self.
-Q, --quieter bool - Write only final hash.
--ipns-base string - Encoding used for keys: Can either be a multibase
encoded CID or a base58btc encoded multihash. Takes
{b58mh|base36|k|base32|b...}. Default: base36.
DESCRIPTION
IPNS is a PKI namespace, where names are the hashes of public keys, and
the private key enables publishing new (signed) values. In both publish
and resolve, the default name used is the node's own PeerID,
which is the hash of its public key.
You can use the 'ipfs key' commands to list and generate more names and their
respective keys.
Examples:
Publish an <ipfs-path> with your default name:
> ipfs name publish /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Publish an <ipfs-path> with another name, added by an 'ipfs key' command:
> ipfs key gen --type=rsa --size=2048 mykey
> ipfs name publish --key=mykey /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Published to QmSrPmbaUKA3ZodhzPWZnpFgcPMFWF4QsxXbkWfEptTBJd: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Alternatively, publish an <ipfs-path> using a valid PeerID (as listed by
'ipfs key list -l'):
> ipfs name publish --key=QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
# ipfs name pubsub
USAGE
ipfs name pubsub - IPNS pubsub management
SYNOPSIS
ipfs name pubsub
DESCRIPTION
Manage and inspect the state of the IPNS pubsub resolver.
Note: this command is experimental and subject to change as the system is refined
SUBCOMMANDS
ipfs name pubsub cancel <name> - Cancel a name subscription
ipfs name pubsub state - Query the state of IPNS pubsub
ipfs name pubsub subs - Show current name subscriptions
For more information about each command, use:
'ipfs name pubsub <subcmd> --help'
# ipfs name pubsub cancel
USAGE
ipfs name pubsub cancel <name> - Cancel a name subscription
SYNOPSIS
ipfs name pubsub cancel [--] <name>
ARGUMENTS
<name> - Name to cancel the subscription for.
# ipfs name pubsub state
USAGE
ipfs name pubsub state - Query the state of IPNS pubsub
SYNOPSIS
ipfs name pubsub state
# ipfs name pubsub subs
USAGE
ipfs name pubsub subs - Show current name subscriptions
SYNOPSIS
ipfs name pubsub subs [--ipns-base=<ipns-base>]
OPTIONS
--ipns-base string - Encoding used for keys: Can either be a multibase
encoded CID or a base58btc encoded multihash. Takes
{b58mh|base36|k|base32|b...}. Default: base36.
# ipfs name resolve
USAGE
ipfs name resolve [<name>] - Resolve IPNS names.
SYNOPSIS
ipfs name resolve [--recursive=false] [--nocache | -n]
[--dht-record-count=<dht-record-count> | --dhtrc]
[--dht-timeout=<dht-timeout> | --dhtt] [--stream | -s] [--]
[<name>]
ARGUMENTS
[<name>] - The IPNS name to resolve. Defaults to your node's peerID.
OPTIONS
-r, --recursive bool - Resolve until the result is not an IPNS
name. Default: true.
-n, --nocache bool - Do not use cached entries.
--dhtrc, --dht-record-count uint - Number of records to request for DHT
resolution.
--dhtt, --dht-timeout string - Max time to collect values during DHT
resolution eg "30s". Pass 0 for no
timeout.
-s, --stream bool - Stream entries as they are found.
DESCRIPTION
IPNS is a PKI namespace, where names are the hashes of public keys, and
the private key enables publishing new (signed) values. In both publish
and resolve, the default name used is the node's own PeerID,
which is the hash of its public key.
You can use the 'ipfs key' commands to list and generate more names and their
respective keys.
Examples:
Resolve the value of your name:
> ipfs name resolve
/ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Resolve the value of another name:
> ipfs name resolve QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
/ipfs/QmSiTko9JZyabH56y2fussEt1A5oDqsFXB3CkvAqraFryz
Resolve the value of a dnslink:
> ipfs name resolve ipfs.io
/ipfs/QmaBvfZooxWkrv7D3r8LS9moNjzD2o525XMZze69hhoxf5
# ipfs object
USAGE
ipfs object - Interact with IPFS objects.
SYNOPSIS
ipfs object
DESCRIPTION
'ipfs object' is a plumbing command used to manipulate DAG objects
directly.
SUBCOMMANDS
ipfs object data <key> - Output the raw bytes of an IPFS object.
ipfs object diff <obj_a> <obj_b> - Display the diff between two ipfs objects.
ipfs object get <key> - Get and serialize the DAG node named by
<key>.
ipfs object links <key> - Output the links pointed to by the
specified object.
ipfs object new [<template>] - Create a new object from an ipfs template.
ipfs object patch - Create a new merkledag object based on an
existing one.
ipfs object put <data> - Store input as a DAG object, print its key.
ipfs object stat <key> - Get stats for the DAG node named by <key>.
For more information about each command, use:
'ipfs object <subcmd> --help'
# ipfs object data
USAGE
ipfs object data <key> - Output the raw bytes of an IPFS object.
SYNOPSIS
ipfs object data [--] <key>
ARGUMENTS
<key> - Key of the object to retrieve, in base58-encoded multihash format.
DESCRIPTION
'ipfs object data' is a plumbing command for retrieving the raw bytes stored
in a DAG node. It outputs to stdout, and <key> is a base58 encoded multihash.
Note that the "--encoding" option does not affect the output, since the output
is the raw data of the object.
# ipfs object diff
USAGE
ipfs object diff <obj_a> <obj_b> - Display the diff between two ipfs objects.
SYNOPSIS
ipfs object diff [--verbose | -v] [--] <obj_a> <obj_b>
ARGUMENTS
<obj_a> - Object to diff against.
<obj_b> - Object to diff.
OPTIONS
-v, --verbose bool - Print extra information.
DESCRIPTION
'ipfs object diff' is a command used to show the differences between
two IPFS objects.
Example:
> ls foo
bar baz/ giraffe
> ipfs add -r foo
...
Added QmegHcnrPgMwC7tBiMxChD54fgQMBUecNw9nE9UUU4x1bz foo
> OBJ_A=QmegHcnrPgMwC7tBiMxChD54fgQMBUecNw9nE9UUU4x1bz
> echo "different content" > foo/bar
> ipfs add -r foo
...
Added QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD foo
> OBJ_B=QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD
> ipfs object diff -v $OBJ_A $OBJ_B
Changed "bar" from QmNgd5cz2jNftnAHBhcRUGdtiaMzb5Rhjqd4etondHHST8 to QmRfFVsjSXkhFxrfWnLpMae2M4GBVsry6VAuYYcji5MiZb.
# ipfs object get
USAGE
ipfs object get <key> - Get and serialize the DAG node named by <key>.
SYNOPSIS
ipfs object get [--data-encoding=<data-encoding>] [--] <key>
ARGUMENTS
<key> - Key of the object to retrieve, in base58-encoded multihash format.
OPTIONS
--data-encoding string - Encoding type of the data field, either "text" or
"base64". Default: text.
DESCRIPTION
'ipfs object get' is a plumbing command for retrieving DAG nodes.
It serializes the DAG node to the format specified by the "--encoding"
flag. It outputs to stdout, and <key> is a base58 encoded multihash.
This command outputs data in the following encodings:
* "protobuf"
* "json"
* "xml"
(Specified by the "--encoding" or "--enc" flag)
The encoding of the object's data field can be specified by using the
--data-encoding flag
Supported values are:
* "text" (default)
* "base64"
# ipfs object links
USAGE
ipfs object links <key> - Output the links pointed to by the specified object.
SYNOPSIS
ipfs object links [--headers | -v] [--] <key>
ARGUMENTS
<key> - Key of the object to retrieve, in base58-encoded multihash format.
OPTIONS
-v, --headers bool - Print table headers (Hash, Size, Name).
DESCRIPTION
'ipfs object links' is a plumbing command for retrieving the links from
a DAG node. It outputs to stdout, and <key> is a base58 encoded
multihash.
# ipfs object new
USAGE
ipfs object new [<template>] - Create a new object from an ipfs template.
SYNOPSIS
ipfs object new [--] [<template>]
ARGUMENTS
[<template>] - Template to use. Optional.
DESCRIPTION
'ipfs object new' is a plumbing command for creating new DAG nodes.
By default it creates and returns a new empty merkledag node, but
you may pass an optional template argument to create a preformatted
node.
Available templates:
* unixfs-dir
# ipfs object patch
USAGE
ipfs object patch - Create a new merkledag object based on an existing one.
SYNOPSIS
ipfs object patch
DESCRIPTION
'ipfs object patch <root> <cmd> <args>' is a plumbing command used to
build custom DAG objects. It mutates objects, creating new objects as a
result. This is the Merkle-DAG version of modifying an object.
SUBCOMMANDS
ipfs object patch add-link <root> <name> <ref> - Add a link to a given object.
ipfs object patch append-data <root> <data> - Append data to the data segment of a dag node.
ipfs object patch rm-link <root> <name> - Remove a link from a given object.
ipfs object patch set-data <root> <data> - Set the data field of an IPFS object.
For more information about each command, use:
'ipfs object patch <subcmd> --help'
# ipfs object patch add-link
USAGE
ipfs object patch add-link <root> <name> <ref> - Add a link to a given object.
SYNOPSIS
ipfs object patch add-link [--create | -p] [--] <root> <name> <ref>
ARGUMENTS
<root> - The hash of the node to modify.
<name> - Name of link to create.
<ref> - IPFS object to add link to.
OPTIONS
-p, --create bool - Create intermediary nodes.
DESCRIPTION
Add a Merkle-link to the given object and return the hash of the result.
Example:
$ EMPTY_DIR=$(ipfs object new unixfs-dir)
$ BAR=$(echo "bar" | ipfs add -q)
$ ipfs object patch $EMPTY_DIR add-link foo $BAR
This takes an empty directory, and adds a link named 'foo' under it, pointing
to a file containing 'bar', and returns the hash of the new object.
# ipfs object patch append-data
USAGE
ipfs object patch append-data <root> <data> - Append data to the data segment
of a dag node.
SYNOPSIS
ipfs object patch append-data [--] <root> <data>
ARGUMENTS
<root> - The hash of the node to modify.
<data> - Data to append.
DESCRIPTION
Append data to what already exists in the data segment in the given object.
Example:
$ echo "hello" | ipfs object patch $HASH append-data
NOTE: This does not append data to a file - it modifies the actual raw
data within an object. Objects have a max size of 1MB and objects larger than
the limit will not be respected by the network.
# ipfs object patch rm-link
USAGE
ipfs object patch rm-link <root> <name> - Remove a link from a given object.
SYNOPSIS
ipfs object patch rm-link [--] <root> <name>
ARGUMENTS
<root> - The hash of the node to modify.
<name> - Name of the link to remove.
DESCRIPTION
Remove a Merkle-link from the given object and return the hash of the result.
# ipfs object patch set-data
USAGE
ipfs object patch set-data <root> <data> - Set the data field of an IPFS
object.
SYNOPSIS
ipfs object patch set-data [--] <root> <data>
ARGUMENTS
<root> - The hash of the node to modify.
<data> - The data to set the object to.
DESCRIPTION
Set the data of an IPFS object from stdin or with the contents of a file.
Example:
$ echo "my data" | ipfs object patch $MYHASH set-data
# ipfs object put
USAGE
ipfs object put <data> - Store input as a DAG object, print its key.
SYNOPSIS
ipfs object put [--inputenc=<inputenc>] [--datafieldenc=<datafieldenc>]
[--pin] [--quiet | -q] [--] <data>
ARGUMENTS
<data> - Data to be stored as a DAG object.
OPTIONS
--inputenc string - Encoding type of input data. One of: {"protobuf",
"json"}. Default: json.
--datafieldenc string - Encoding type of the data field, either "text" or
"base64". Default: text.
--pin bool - Pin this object when adding.
-q, --quiet bool - Write minimal output.
DESCRIPTION
'ipfs object put' is a plumbing command for storing DAG nodes.
It reads from stdin, and the output is a base58 encoded multihash.
Data should be in the format specified by the --inputenc flag.
--inputenc may be one of the following:
* "protobuf"
* "json" (default)
Examples:
$ echo '{ "Data": "abc" }' | ipfs object put
This creates a node with the data 'abc' and no links. For an object with
links, create a file named 'node.json' with the contents:
{
"Data": "another",
"Links": [ {
"Name": "some link",
"Hash": "QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39V",
"Size": 8
} ]
}
And then run:
$ ipfs object put node.json
# ipfs object stat
USAGE
ipfs object stat <key> - Get stats for the DAG node named by <key>.
SYNOPSIS
ipfs object stat [--human] [--] <key>
ARGUMENTS
<key> - Key of the object to retrieve, in base58-encoded multihash format.
OPTIONS
--human bool - Print sizes in human readable format (e.g., 1K 234M 2G).
DESCRIPTION
'ipfs object stat' is a plumbing command to print DAG node statistics.
<key> is a base58 encoded multihash. It outputs to stdout:
NumLinks int number of links in link table
BlockSize int size of the raw, encoded data
LinksSize int size of the links segment
DataSize int size of the data segment
CumulativeSize int cumulative size of object and its references
# ipfs p2p
USAGE
ipfs p2p - Libp2p stream mounting.
SYNOPSIS
ipfs p2p
DESCRIPTION
Create and use tunnels to remote peers over libp2p
Note: this command is experimental and subject to change as usecases and APIs
are refined
SUBCOMMANDS
ipfs p2p close - Stop listening for new connections to forward.
ipfs p2p forward <protocol> <listen-address> <target-address> - Forward connections to libp2p service
ipfs p2p listen <protocol> <target-address> - Create libp2p service
ipfs p2p ls - List active p2p listeners.
ipfs p2p stream - P2P stream management.
For more information about each command, use:
'ipfs p2p <subcmd> --help'
# ipfs p2p close
USAGE
ipfs p2p close - Stop listening for new connections to forward.
SYNOPSIS
ipfs p2p close [--all | -a] [--protocol=<protocol> | -p]
[--listen-address=<listen-address> | -l]
[--target-address=<target-address> | -t]
OPTIONS
-a, --all bool - Close all listeners.
-p, --protocol string - Match protocol name.
-l, --listen-address string - Match listen address.
-t, --target-address string - Match target address.
# ipfs p2p forward
USAGE
ipfs p2p forward <protocol> <listen-address> <target-address> - Forward connections to libp2p service
SYNOPSIS
ipfs p2p forward [--allow-custom-protocol] [--] <protocol> <listen-address>
<target-address>
ARGUMENTS
<protocol> - Protocol name.
<listen-address> - Listening endpoint.
<target-address> - Target endpoint.
OPTIONS
--allow-custom-protocol bool - Don't require /x/ prefix.
DESCRIPTION
Forward connections made to <listen-address> to <target-address>.
<protocol> specifies the libp2p protocol name to use for libp2p
connections and/or handlers. It must be prefixed with '/x/'.
Example:
ipfs p2p forward /x/myproto /ip4/127.0.0.1/tcp/4567 /p2p/QmPeer
- Forward connections to 127.0.0.1:4567 to '/x/myproto' service on /p2p/QmPeer
# ipfs p2p listen
USAGE
ipfs p2p listen <protocol> <target-address> - Create libp2p service
SYNOPSIS
ipfs p2p listen [--allow-custom-protocol] [--report-peer-id | -r] [--]
<protocol> <target-address>
ARGUMENTS
<protocol> - Protocol name.
<target-address> - Target endpoint.
OPTIONS
--allow-custom-protocol bool - Don't require /x/ prefix.
-r, --report-peer-id bool - Send remote base58 peerid to target when a
new connection is established.
DESCRIPTION
Create libp2p service and forward connections made to <target-address>.
<protocol> specifies the libp2p handler name. It must be prefixed with '/x/'.
Example:
ipfs p2p listen /x/myproto /ip4/127.0.0.1/tcp/1234
- Forward connections to 'myproto' libp2p service to 127.0.0.1:1234
# ipfs p2p ls
USAGE
ipfs p2p ls - List active p2p listeners.
SYNOPSIS
ipfs p2p ls [--headers | -v]
OPTIONS
-v, --headers bool - Print table headers (Protocol, Listen, Target).
# ipfs p2p stream
USAGE
ipfs p2p stream - P2P stream management.
SYNOPSIS
ipfs p2p stream
DESCRIPTION
Create and manage p2p streams
SUBCOMMANDS
ipfs p2p stream close [<id>] - Close active p2p stream.
ipfs p2p stream ls - List active p2p streams.
For more information about each command, use:
'ipfs p2p stream <subcmd> --help'
# ipfs p2p stream close
USAGE
ipfs p2p stream close [<id>] - Close active p2p stream.
SYNOPSIS
ipfs p2p stream close [--all | -a] [--] [<id>]
ARGUMENTS
[<id>] - Stream identifier
OPTIONS
-a, --all bool - Close all streams.
# ipfs p2p stream ls
USAGE
ipfs p2p stream ls - List active p2p streams.
SYNOPSIS
ipfs p2p stream ls [--headers | -v]
OPTIONS
-v, --headers bool - Print table headers (ID, Protocol, Local, Remote).
# ipfs pin
USAGE
ipfs pin - Pin (and unpin) objects to local storage.
SYNOPSIS
ipfs pin
SUBCOMMANDS
ipfs pin add <ipfs-path>... - Pin objects to local storage.
ipfs pin ls [<ipfs-path>]... - List objects pinned to local storage.
ipfs pin remote - Pin (and unpin) objects to remote
pinning service.
ipfs pin rm <ipfs-path>... - Remove pinned objects from local
storage.
ipfs pin update <from-path> <to-path> - Update a recursive pin
ipfs pin verify - Verify that recursive pins are
complete.
For more information about each command, use:
'ipfs pin <subcmd> --help'
# ipfs pin add
USAGE
ipfs pin add <ipfs-path>... - Pin objects to local storage.
SYNOPSIS
ipfs pin add [--recursive=false] [--progress] [--] <ipfs-path>...
ARGUMENTS
<ipfs-path>... - Path to object(s) to be pinned.
OPTIONS
-r, --recursive bool - Recursively pin the object linked to by the specified
object(s). Default: true.
--progress bool - Show progress.
DESCRIPTION
Stores an IPFS object(s) from a given path locally to disk.
# ipfs pin ls
USAGE
ipfs pin ls [<ipfs-path>]... - List objects pinned to local storage.
SYNOPSIS
ipfs pin ls [--type=<type> | -t] [--quiet | -q] [--stream | -s] [--]
[<ipfs-path>...]
ARGUMENTS
[<ipfs-path>]... - Path to object(s) to be listed.
OPTIONS
-t, --type string - The type of pinned keys to list. Can be "direct",
"indirect", "recursive", or "all". Default: all.
-q, --quiet bool - Write just hashes of objects.
-s, --stream bool - Enable streaming of pins as they are discovered.
DESCRIPTION
Returns a list of objects that are pinned locally.
By default, all pinned objects are returned, but the '--type' flag or
arguments can restrict that to a specific pin type or to some specific objects
respectively.
Use --type=<type> to specify the type of pinned keys to list.
Valid values are:
* "direct": pin that specific object.
* "recursive": pin that specific object, and indirectly pin all its
descendants
* "indirect": pinned indirectly by an ancestor (like a refcount)
* "all"
With arguments, the command fails if any of the arguments is not a pinned
object. And if --type=<type> is additionally used, the command will also fail
if any of the arguments is not of the specified type.
Example:
$ echo "hello" | ipfs add -q
QmZULkCELmmk5XNfCgTnCyFgAVxBRBXyDHGGMVoLFLiXEN
$ ipfs pin ls
QmZULkCELmmk5XNfCgTnCyFgAVxBRBXyDHGGMVoLFLiXEN recursive
# now remove the pin, and repin it directly
$ ipfs pin rm QmZULkCELmmk5XNfCgTnCyFgAVxBRBXyDHGGMVoLFLiXEN
unpinned QmZULkCELmmk5XNfCgTnCyFgAVxBRBXyDHGGMVoLFLiXEN
$ ipfs pin add -r=false QmZULkCELmmk5XNfCgTnCyFgAVxBRBXyDHGGMVoLFLiXEN
pinned QmZULkCELmmk5XNfCgTnCyFgAVxBRBXyDHGGMVoLFLiXEN directly
$ ipfs pin ls --type=direct
QmZULkCELmmk5XNfCgTnCyFgAVxBRBXyDHGGMVoLFLiXEN direct
$ ipfs pin ls QmZULkCELmmk5XNfCgTnCyFgAVxBRBXyDHGGMVoLFLiXEN
QmZULkCELmmk5XNfCgTnCyFgAVxBRBXyDHGGMVoLFLiXEN direct
# ipfs pin remote
USAGE
ipfs pin remote - Pin (and unpin) objects to remote pinning service.
SYNOPSIS
ipfs pin remote
SUBCOMMANDS
ipfs pin remote add <ipfs-path> - Pin object to remote pinning service.
ipfs pin remote ls - List objects pinned to remote pinning
service.
ipfs pin remote rm - Remove pins from remote pinning service.
ipfs pin remote service - Configure remote pinning services.
For more information about each command, use:
'ipfs pin remote <subcmd> --help'
# ipfs pin remote add
USAGE
ipfs pin remote add <ipfs-path> - Pin object to remote pinning service.
SYNOPSIS
ipfs pin remote add [--service=<service>] [--name=<name>] [--background] [--]
<ipfs-path>
ARGUMENTS
<ipfs-path> - Path to object(s) to be pinned.
OPTIONS
--service string - Name of the remote pinning service to use (mandatory).
--name string - An optional name for the pin.
--background bool - Add to the queue on the remote service and return
immediately (does not wait for pinned status).
Default: false.
DESCRIPTION
Asks remote pinning service to pin an IPFS object from a given path or a CID.
To pin CID 'bafkqaaa' to service named 'mysrv' under a pin named 'mypin':
$ ipfs pin remote add --service=mysrv --name=mypin bafkqaaa
The above command will block until remote service returns 'pinned' status,
which may take time depending on the size and available providers of the pinned
data.
If you prefer to not wait for pinning confirmation and return immediately
after remote service confirms 'queued' status, add the '--background' flag:
$ ipfs pin remote add --service=mysrv --name=mypin --background bafkqaaa
Status of background pin requests can be inspected with the 'ls' command.
To list all pins for the CID across all statuses:
$ ipfs pin remote ls --service=mysrv --cid=bafkqaaa --status=queued \
--status=pinning --status=pinned --status=failed
NOTE: a comma-separated notation is supported in CLI for convenience:
$ ipfs pin remote ls --service=mysrv --cid=bafkqaaa --status=queued,pinning,pinned,failed
# ipfs pin remote ls
USAGE
ipfs pin remote ls - List objects pinned to remote pinning service.
SYNOPSIS
ipfs pin remote ls [--service=<service>] [--name=<name>] [--cid=<cid>]...
[--status=<status>]...
OPTIONS
--service string - Name of the remote pinning service to use (mandatory).
--name string - Return pins with names that contain the value provided
(case-sensitive, exact match).
--cid array - Return pins for the specified CIDs (comma-separated).
--status array - Return pins with the specified statuses
(queued,pinning,pinned,failed). Default: [pinned].
DESCRIPTION
Returns a list of objects that are pinned to a remote pinning service.
NOTE: By default, it will only show matching objects in 'pinned' state.
Pass '--status=queued,pinning,pinned,failed' to list pins in all states.
# ipfs pin remote rm
USAGE
ipfs pin remote rm - Remove pins from remote pinning service.
SYNOPSIS
ipfs pin remote rm [--service=<service>] [--name=<name>] [--cid=<cid>]...
[--status=<status>]... [--force]
OPTIONS
--service string - Name of the remote pinning service to use (mandatory).
--name string - Remove pins with names that contain provided value
(case-sensitive, exact match).
--cid array - Remove pins for the specified CIDs.
--status array - Remove pins with the specified statuses
(queued,pinning,pinned,failed). Default: [pinned].
--force bool - Allow removal of multiple pins matching the query without
additional confirmation. Default: false.
DESCRIPTION
Removes remote pins, allowing them to be garbage-collected if needed.
This command accepts the same search query parameters as 'ls', and it is good
practice to execute 'ls' before 'rm' to confirm the list of pins to be removed.
To remove a single pin for a specific CID:
$ ipfs pin remote ls --service=mysrv --cid=bafkqaaa
$ ipfs pin remote rm --service=mysrv --cid=bafkqaaa
When more than one pin matches the query on the remote service, an error is
returned. To confirm the removal of multiple pins, pass '--force':
$ ipfs pin remote ls --service=mysrv --name=popular-name
$ ipfs pin remote rm --service=mysrv --name=popular-name --force
NOTE: When no '--status' is passed, implicit '--status=pinned' is used.
To list and then remove all pending pin requests, pass an explicit status list:
$ ipfs pin remote ls --service=mysrv --status=queued,pinning,failed
$ ipfs pin remote rm --service=mysrv --status=queued,pinning,failed --force
# ipfs pin remote service
USAGE
ipfs pin remote service - Configure remote pinning services.
SYNOPSIS
ipfs pin remote service
SUBCOMMANDS
ipfs pin remote service add <service> <endpoint> <key> - Add remote pinning service.
ipfs pin remote service ls - List remote pinning services.
ipfs pin remote service rm <service> - Remove remote pinning service.
For more information about each command, use:
'ipfs pin remote service <subcmd> --help'
# ipfs pin remote service add
USAGE
ipfs pin remote service add <service> <endpoint> <key> - Add remote pinning service.
SYNOPSIS
ipfs pin remote service add [--] <service> <endpoint> <key>
ARGUMENTS
<service> - Service name.
<endpoint> - Service endpoint.
<key> - Service key.
DESCRIPTION
Add credentials for access to a remote pinning service and store them in the
config under Pinning.RemoteServices map.
TIP:
To add services and test them by fetching pin count stats:
$ ipfs pin remote service add goodsrv https://pin-api.example.com secret-key
$ ipfs pin remote service add badsrv https://bad-api.example.com invalid-key
$ ipfs pin remote service ls --stat
goodsrv https://pin-api.example.com 0/0/0/0
badsrv https://bad-api.example.com invalid
# ipfs pin remote service ls
USAGE
ipfs pin remote service ls - List remote pinning services.
SYNOPSIS
ipfs pin remote service ls [--stat]
OPTIONS
--stat bool - Try to fetch and display current pin count on remote service
(queued/pinning/pinned/failed). Default: false.
DESCRIPTION
List remote pinning services.
By default, only a name and an endpoint are listed; however, one can pass
'--stat' to test each endpoint by fetching pin counts for each state:
$ ipfs pin remote service ls --stat
goodsrv https://pin-api.example.com 0/0/0/0
badsrv https://bad-api.example.com invalid
TIP: pass '--enc=json' for more useful JSON output.
# ipfs pin remote service rm
USAGE
ipfs pin remote service rm <service> - Remove remote pinning service.
SYNOPSIS
ipfs pin remote service rm [--] <service>
ARGUMENTS
<service> - Name of remote pinning service to remove.
DESCRIPTION
Remove credentials for access to a remote pinning service.
# ipfs pin rm
USAGE
ipfs pin rm <ipfs-path>... - Remove pinned objects from local storage.
SYNOPSIS
ipfs pin rm [--recursive=false] [--] <ipfs-path>...
ARGUMENTS
<ipfs-path>... - Path to object(s) to be unpinned.
OPTIONS
-r, --recursive bool - Recursively unpin the object linked to by the
specified object(s). Default: true.
DESCRIPTION
Removes the pin from the given object allowing it to be garbage
collected if needed. (By default, recursively. Use -r=false for direct pins.)
# ipfs pin update
USAGE
ipfs pin update <from-path> <to-path> - Update a recursive pin
SYNOPSIS
ipfs pin update [--unpin=false] [--] <from-path> <to-path>
ARGUMENTS
<from-path> - Path to old object.
<to-path> - Path to a new object to be pinned.
OPTIONS
--unpin bool - Remove the old pin. Default: true.
DESCRIPTION
Efficiently pins a new object based on differences from an existing one and,
by default, removes the old pin.
This command is useful when the new pin contains many similarities or is a
derivative of an existing one, particularly for large objects. This allows a more
efficient DAG-traversal which fully skips already-pinned branches from the old
object. As a requirement, the old object needs to be an existing recursive
pin.
# ipfs pin verify
USAGE
ipfs pin verify - Verify that recursive pins are complete.
SYNOPSIS
ipfs pin verify [--verbose] [--quiet | -q]
OPTIONS
--verbose bool - Also write the hashes of non-broken pins.
-q, --quiet bool - Write just hashes of broken pins.
# ipfs ping
USAGE
ipfs ping <peer ID>... - Send echo request packets to IPFS hosts.
SYNOPSIS
ipfs ping [--count=<count> | -n] [--] <peer ID>...
ARGUMENTS
<peer ID>... - ID of peer to be pinged.
OPTIONS
-n, --count int - Number of ping messages to send. Default: 10.
DESCRIPTION
'ipfs ping' is a tool to test sending data to other nodes. It finds nodes
via the routing system, sends pings, waits for pongs, and prints out round-
trip latency information.
# ipfs pubsub
USAGE
ipfs pubsub - An experimental publish-subscribe system on ipfs.
SYNOPSIS
ipfs pubsub
DESCRIPTION
ipfs pubsub allows you to publish messages to a given topic, and also to
subscribe to new messages on a given topic.
This is an experimental feature. It is not intended in its current state
to be used in a production environment.
To use, the daemon must be run with '--enable-pubsub-experiment'.
SUBCOMMANDS
ipfs pubsub ls - List subscribed topics by name.
ipfs pubsub peers [<topic>] - List peers we are currently pubsubbing
with.
ipfs pubsub pub <topic> <data>... - Publish a message to a given pubsub topic.
ipfs pubsub sub <topic> - Subscribe to messages on a given topic.
For more information about each command, use:
'ipfs pubsub <subcmd> --help'
# ipfs pubsub ls
USAGE
ipfs pubsub ls - List subscribed topics by name.
SYNOPSIS
ipfs pubsub ls
DESCRIPTION
ipfs pubsub ls lists out the names of topics you are currently subscribed to.
This is an experimental feature. It is not intended in its current state
to be used in a production environment.
To use, the daemon must be run with '--enable-pubsub-experiment'.
# ipfs pubsub peers
USAGE
ipfs pubsub peers [<topic>] - List peers we are currently pubsubbing with.
SYNOPSIS
ipfs pubsub peers [--] [<topic>]
ARGUMENTS
[<topic>] - topic to list connected peers of
DESCRIPTION
ipfs pubsub peers with no arguments lists out the pubsub peers you are
currently connected to. If given a topic, it will list connected
peers who are subscribed to the named topic.
This is an experimental feature. It is not intended in its current state
to be used in a production environment.
To use, the daemon must be run with '--enable-pubsub-experiment'.
# ipfs pubsub pub
USAGE
ipfs pubsub pub <topic> <data>... - Publish a message to a given pubsub topic.
SYNOPSIS
ipfs pubsub pub [--] <topic> <data>...
ARGUMENTS
<topic> - Topic to publish to.
<data>... - Payload of message to publish.
DESCRIPTION
ipfs pubsub pub publishes a message to a specified topic.
This is an experimental feature. It is not intended in its current state
to be used in a production environment.
To use, the daemon must be run with '--enable-pubsub-experiment'.
# ipfs pubsub sub
USAGE
ipfs pubsub sub <topic> - Subscribe to messages on a given topic.
SYNOPSIS
ipfs pubsub sub [--discover] [--] <topic>
ARGUMENTS
<topic> - String name of topic to subscribe to.
OPTIONS
--discover bool - Deprecated option to instruct pubsub to discovery peers
for the topic. Discovery is now built into pubsub.
DESCRIPTION
ipfs pubsub sub subscribes to messages on a given topic.
This is an experimental feature. It is not intended in its current state
to be used in a production environment.
To use, the daemon must be run with '--enable-pubsub-experiment'.
This command outputs data in the following encodings:
* "json"
(Specified by the "--encoding" or "--enc" flag)
# ipfs refs
USAGE
ipfs refs <ipfs-path>... - List links (references) from an object.
SYNOPSIS
ipfs refs [--format=<format>] [--edges | -e] [--unique | -u]
[--recursive | -r] [--max-depth=<max-depth>] [--] <ipfs-path>...
ARGUMENTS
<ipfs-path>... - Path to the object(s) to list refs from.
OPTIONS
--format string - Emit edges with given format. Available tokens:
<src> <dst> <linkname>. Default: <dst>.
-e, --edges bool - Emit edge format: `<from> -> <to>`.
-u, --unique bool - Omit duplicate refs from output.
-r, --recursive bool - Recursively list links of child nodes.
--max-depth int - Only for recursive refs, limits fetch and listing
to the given depth. Default: -1.
DESCRIPTION
Lists the hashes of all the links an IPFS or IPNS object(s) contains,
with the following format:
<link base58 hash>
NOTE: List all references recursively by using the flag '-r'.
SUBCOMMANDS
ipfs refs local - List all local references.
For more information about each command, use:
'ipfs refs <subcmd> --help'
# ipfs refs local
USAGE
ipfs refs local - List all local references.
SYNOPSIS
ipfs refs local
DESCRIPTION
Displays the hashes of all local objects.
# ipfs repo
USAGE
ipfs repo - Manipulate the IPFS repo.
SYNOPSIS
ipfs repo
DESCRIPTION
'ipfs repo' is a plumbing command used to manipulate the repo.
SUBCOMMANDS
ipfs repo fsck - Remove repo lockfiles.
ipfs repo gc - Perform a garbage collection sweep on the repo.
ipfs repo stat - Get stats for the currently used repo.
ipfs repo verify - Verify all blocks in repo are not corrupted.
ipfs repo version - Show the repo version.
For more information about each command, use:
'ipfs repo <subcmd> --help'
# ipfs repo fsck
USAGE
ipfs repo fsck - Remove repo lockfiles.
SYNOPSIS
ipfs repo fsck
DESCRIPTION
'ipfs repo fsck' is now a no-op.
# ipfs repo gc
USAGE
ipfs repo gc - Perform a garbage collection sweep on the repo.
SYNOPSIS
ipfs repo gc [--stream-errors] [--quiet | -q]
OPTIONS
--stream-errors bool - Stream errors.
-q, --quiet bool - Write minimal output.
DESCRIPTION
'ipfs repo gc' is a plumbing command that will sweep the local
set of stored objects and remove ones that are not pinned in
order to reclaim hard disk space.
# ipfs repo stat
USAGE
ipfs repo stat - Get stats for the currently used repo.
SYNOPSIS
ipfs repo stat [--size-only | -s] [--human | -H]
OPTIONS
-s, --size-only bool - Only report RepoSize and StorageMax.
-H, --human bool - Print sizes in human readable format (e.g., 1K 234M
2G).
DESCRIPTION
'ipfs repo stat' provides information about the local set of
stored objects. It outputs:
RepoSize int Size in bytes that the repo is currently taking.
StorageMax string Maximum datastore size (from configuration)
NumObjects int Number of objects in the local repo.
RepoPath string The path to the repo being currently used.
Version string The repo version.
# ipfs repo verify
USAGE
ipfs repo verify - Verify all blocks in repo are not corrupted.
SYNOPSIS
ipfs repo verify
# ipfs repo version
USAGE
ipfs repo version - Show the repo version.
SYNOPSIS
ipfs repo version [--quiet | -q]
OPTIONS
-q, --quiet bool - Write minimal output.
DESCRIPTION
'ipfs repo version' returns the current repo version.
# ipfs resolve
USAGE
ipfs resolve <name> - Resolve the value of names to IPFS.
SYNOPSIS
ipfs resolve [--recursive=false]
[--dht-record-count=<dht-record-count> | --dhtrc]
[--dht-timeout=<dht-timeout> | --dhtt] [--] <name>
ARGUMENTS
<name> - The name to resolve.
OPTIONS
-r, --recursive bool - Resolve until the result is an IPFS
name. Default: true.
--dhtrc, --dht-record-count int - Number of records to request for DHT
resolution.
--dhtt, --dht-timeout string - Max time to collect values during DHT
resolution eg "30s". Pass 0 for no
timeout.
DESCRIPTION
There are a number of mutable name protocols that can link among
themselves and into IPNS. For example IPNS references can (currently)
point at an IPFS object, and DNS links can point at other DNS links, IPNS
entries, or IPFS objects. This command accepts any of these
identifiers and resolves them to the referenced item.
EXAMPLES
Resolve the value of your identity:
$ ipfs resolve /ipns/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
/ipfs/Qmcqtw8FfrVSBaRmbWwHxt3AuySBhJLcvmFYi3Lbc4xnwj
Resolve the value of another name:
$ ipfs resolve /ipns/QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n
/ipns/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
Resolve the value of another name recursively:
$ ipfs resolve -r /ipns/QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n
/ipfs/Qmcqtw8FfrVSBaRmbWwHxt3AuySBhJLcvmFYi3Lbc4xnwj
Resolve the value of an IPFS DAG path:
$ ipfs resolve /ipfs/QmeZy1fGbwgVSrqbfh9fKQrAWgeyRnj7h8fsHS1oy3k99x/beep/boop
/ipfs/QmYRMjyvAiHKN9UTi8Bzt1HUspmSRD8T8DwxfSMzLgBon1
# ipfs shutdown
USAGE
ipfs shutdown - Shut down the ipfs daemon
SYNOPSIS
ipfs shutdown
# ipfs stats
USAGE
ipfs stats - Query IPFS statistics.
SYNOPSIS
ipfs stats
DESCRIPTION
'ipfs stats' is a set of commands to help look at statistics
for your IPFS node.
SUBCOMMANDS
ipfs stats bitswap - Show some diagnostic information on the bitswap
agent.
ipfs stats bw - Print ipfs bandwidth information.
ipfs stats dht [<dht>]... - Returns statistics about the node's DHT(s)
ipfs stats repo - Get stats for the currently used repo.
For more information about each command, use:
'ipfs stats <subcmd> --help'
# ipfs stats bitswap
USAGE
ipfs stats bitswap - Show some diagnostic information on the bitswap agent.
SYNOPSIS
ipfs stats bitswap [--verbose | -v] [--human]
OPTIONS
-v, --verbose bool - Print extra information.
--human bool - Print sizes in human readable format (e.g., 1K 234M 2G).
# ipfs stats bw
USAGE
ipfs stats bw - Print ipfs bandwidth information.
SYNOPSIS
ipfs stats bw [--peer=<peer> | -p] [--proto=<proto> | -t] [--poll]
[--interval=<interval> | -i]
OPTIONS
-p, --peer string - Specify a peer to print bandwidth for.
-t, --proto string - Specify a protocol to print bandwidth for.
--poll bool - Print bandwidth at an interval.
-i, --interval string - Time interval to wait between updating output, if
'poll' is true.
This accepts durations such as
"300s", "1.5h" or "2h45m". Valid time units are:
"ns", "us" (or "µs"), "ms", "s", "m", "h". Default:
1s.
DESCRIPTION
'ipfs stats bw' prints bandwidth information for the ipfs daemon.
It displays: TotalIn, TotalOut, RateIn, RateOut.
By default, overall bandwidth and all protocols are shown. To limit bandwidth
to a particular peer, use the 'peer' option along with that peer's multihash
id. To specify a specific protocol, use the 'proto' option. The 'peer' and
'proto' options cannot be specified simultaneously. The protocols that are
queried using this method are outlined in the specification:
https://github.com/libp2p/specs/blob/master/7-properties.md#757-protocol-multicodecs
Example protocol options:
- /ipfs/id/1.0.0
- /ipfs/bitswap
- /ipfs/dht
Example:
> ipfs stats bw -t /ipfs/bitswap
Bandwidth
TotalIn: 5.0MB
TotalOut: 0B
RateIn: 343B/s
RateOut: 0B/s
> ipfs stats bw -p QmepgFW7BHEtU4pZJdxaNiv75mKLLRQnPi1KaaXmQN4V1a
Bandwidth
TotalIn: 4.9MB
TotalOut: 12MB
RateIn: 0B/s
RateOut: 0B/s
# ipfs stats dht
USAGE
ipfs stats dht [<dht>]... - Returns statistics about the node's DHT(s)
SYNOPSIS
ipfs stats dht [--] [<dht>...]
ARGUMENTS
[<dht>]... - The DHT whose table should be listed (wan or lan). Defaults to
both.
DESCRIPTION
Returns statistics about the DHT(s) the node is participating in.
This interface is not stable and may change from release to release.
# ipfs stats repo
USAGE
ipfs stats repo - Get stats for the currently used repo.
SYNOPSIS
ipfs stats repo [--size-only | -s] [--human | -H]
OPTIONS
-s, --size-only bool - Only report RepoSize and StorageMax.
-H, --human bool - Print sizes in human readable format (e.g., 1K 234M
2G).
DESCRIPTION
'ipfs repo stat' provides information about the local set of
stored objects. It outputs:
RepoSize int Size in bytes that the repo is currently taking.
StorageMax string Maximum datastore size (from configuration)
NumObjects int Number of objects in the local repo.
RepoPath string The path to the repo being currently used.
Version string The repo version.
# ipfs swarm
USAGE
ipfs swarm - Interact with the swarm.
SYNOPSIS
ipfs swarm
DESCRIPTION
'ipfs swarm' is a tool to manipulate the network swarm. The swarm is the
component that opens, listens for, and maintains connections to other
ipfs peers in the internet.
SUBCOMMANDS
ipfs swarm addrs - List known addresses. Useful for
debugging.
ipfs swarm connect <address>... - Open connection to a given address.
ipfs swarm disconnect <address>... - Close connection to a given address.
ipfs swarm filters - Manipulate address filters.
ipfs swarm peers - List peers with open connections.
For more information about each command, use:
'ipfs swarm <subcmd> --help'
# ipfs swarm addrs
USAGE
ipfs swarm addrs - List known addresses. Useful for debugging.
SYNOPSIS
ipfs swarm addrs
DESCRIPTION
'ipfs swarm addrs' lists all addresses this node is aware of.
SUBCOMMANDS
ipfs swarm addrs listen - List interface listening addresses.
ipfs swarm addrs local - List local addresses.
For more information about each command, use:
'ipfs swarm addrs <subcmd> --help'
# ipfs swarm addrs listen
USAGE
ipfs swarm addrs listen - List interface listening addresses.
SYNOPSIS
ipfs swarm addrs listen
DESCRIPTION
'ipfs swarm addrs listen' lists all interface addresses the node is listening on.
# ipfs swarm addrs local
USAGE
ipfs swarm addrs local - List local addresses.
SYNOPSIS
ipfs swarm addrs local [--id]
OPTIONS
--id bool - Show peer ID in addresses.
DESCRIPTION
'ipfs swarm addrs local' lists all local listening addresses announced to the network.
# ipfs swarm connect
USAGE
ipfs swarm connect <address>... - Open connection to a given address.
SYNOPSIS
ipfs swarm connect [--] <address>...
ARGUMENTS
<address>... - Address of peer to connect to.
DESCRIPTION
'ipfs swarm connect' opens a new direct connection to a peer address.
The address format is an IPFS multiaddr:
ipfs swarm connect /ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
# ipfs swarm disconnect
USAGE
ipfs swarm disconnect <address>... - Close connection to a given address.
SYNOPSIS
ipfs swarm disconnect [--] <address>...
ARGUMENTS
<address>... - Address of peer to disconnect from.
DESCRIPTION
'ipfs swarm disconnect' closes a connection to a peer address. The address
format is an IPFS multiaddr:
ipfs swarm disconnect /ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
The disconnect is not permanent; if ipfs needs to talk to that address later,
it will reconnect.
# ipfs swarm filters
USAGE
ipfs swarm filters - Manipulate address filters.
SYNOPSIS
ipfs swarm filters
DESCRIPTION
'ipfs swarm filters' will list out currently applied filters. Its subcommands
can be used to add or remove said filters. Filters are specified using the
multiaddr-filter format:
Example:
/ip4/192.168.0.0/ipcidr/16
Where the above is equivalent to the standard CIDR:
192.168.0.0/16
Filters default to those specified under the "Swarm.AddrFilters" config key.
SUBCOMMANDS
ipfs swarm filters add <address>... - Add an address filter.
ipfs swarm filters rm <address>... - Remove an address filter.
For more information about each command, use:
'ipfs swarm filters <subcmd> --help'
# ipfs swarm filters add
USAGE
ipfs swarm filters add <address>... - Add an address filter.
SYNOPSIS
ipfs swarm filters add [--] <address>...
ARGUMENTS
<address>... - Multiaddr to filter.
DESCRIPTION
'ipfs swarm filters add' will add an address filter to the daemons swarm.
# ipfs swarm filters rm
USAGE
ipfs swarm filters rm <address>... - Remove an address filter.
SYNOPSIS
ipfs swarm filters rm [--] <address>...
ARGUMENTS
<address>... - Multiaddr filter to remove.
DESCRIPTION
'ipfs swarm filters rm' will remove an address filter from the daemons swarm.
# ipfs swarm peers
USAGE
ipfs swarm peers - List peers with open connections.
SYNOPSIS
ipfs swarm peers [--verbose | -v] [--streams] [--latency] [--direction]
OPTIONS
-v, --verbose bool - display all extra information.
--streams bool - Also list information about open streams for each peer.
--latency bool - Also list information about latency to each peer.
--direction bool - Also list information about the direction of connection.
DESCRIPTION
'ipfs swarm peers' lists the set of peers this node is connected to.
# ipfs tar
USAGE
ipfs tar - Utility functions for tar files in ipfs.
SYNOPSIS
ipfs tar
SUBCOMMANDS
ipfs tar add <file> - Import a tar file into ipfs.
ipfs tar cat <path> - Export a tar file from IPFS.
For more information about each command, use:
'ipfs tar <subcmd> --help'
# ipfs tar add
USAGE
ipfs tar add <file> - Import a tar file into ipfs.
SYNOPSIS
ipfs tar add [--] <file>
ARGUMENTS
<file> - Tar file to add.
DESCRIPTION
'ipfs tar add' will parse a tar file and create a merkledag structure to
represent it.
# ipfs tar cat
USAGE
ipfs tar cat <path> - Export a tar file from IPFS.
SYNOPSIS
ipfs tar cat [--] <path>
ARGUMENTS
<path> - ipfs path of archive to export.
DESCRIPTION
'ipfs tar cat' will export a tar file from a previously imported one in IPFS.
# ipfs update
ipfs-update is an 'external' command.
It does not currently appear to be installed.
Please see https://git.io/fjylH for installation instructions.
# ipfs urlstore
USAGE
ipfs urlstore - Interact with urlstore.
SYNOPSIS
ipfs urlstore
SUBCOMMANDS
ipfs urlstore add <url> - Add URL via urlstore.
For more information about each command, use:
'ipfs urlstore <subcmd> --help'
# ipfs urlstore add
USAGE
ipfs urlstore add <url> - Add URL via urlstore.
SYNOPSIS
ipfs urlstore add [--trickle | -t] [--pin=false] [--] <url>
ARGUMENTS
<url> - URL to add to IPFS
OPTIONS
-t, --trickle bool - Use trickle-dag format for dag generation.
--pin bool - Pin this object when adding. Default: true.
DESCRIPTION
DEPRECATED: Use 'ipfs add --nocopy --cid-version=1 URL'.
Add URLs to ipfs without storing the data locally.
The URL provided must be stable and ideally on a web server under your
control.
The file is added using raw-leaves but otherwise using the default
settings for 'ipfs add'.
# ipfs version
USAGE
ipfs version - Show ipfs version information.
SYNOPSIS
ipfs version [--number | -n] [--commit] [--repo] [--all]
OPTIONS
-n, --number bool - Only show the version number.
--commit bool - Show the commit hash.
--repo bool - Show repo version.
--all bool - Show all version information.
DESCRIPTION
Returns the current version of ipfs and exits.
SUBCOMMANDS
ipfs version deps - Shows information about dependencies used for build
For more information about each command, use:
'ipfs version <subcmd> --help'
# ipfs version deps
USAGE
ipfs version deps - Shows information about dependencies used for build
SYNOPSIS
ipfs version deps
DESCRIPTION
Print out all dependencies and their versions.