注意: IPFS可以在“在线”(您将IPFS作为实例单独运行)或“离线”模式运行,但某些命令仅在联机时支持。例如,ipfs swarm peers
仅在在线模式下工作,因为如果您处于离线状态,则根本不会连接到群。有关将IPFS作为示例运行的更多信息,请参阅使用文档中的“联机”。
生成于 2018-04-09 13:54:54.079504
- ipfs
- ipfs add
- ipfs bitswap
- ipfs bitswap ledger
- ipfs bitswap reprovide
- ipfs bitswap stat
- ipfs bitswap unwant
- ipfs bitswap wantlist
- ipfs block
- ipfs block get
- ipfs block put
- ipfs block rm
- ipfs block stat
- ipfs bootstrap
- ipfs bootstrap add
- ipfs bootstrap add default
- ipfs bootstrap list
- ipfs bootstrap rm
- ipfs bootstrap rm all
- ipfs cat
- ipfs commands
- ipfs config
- ipfs config edit
- ipfs config profile
- ipfs config profile apply
- ipfs config replace
- ipfs config show
- ipfs daemon
- ipfs dag
- ipfs dag get
- ipfs dag put
- ipfs dag resolve
- ipfs dht
- ipfs dht findpeer
- ipfs dht findprovs
- ipfs dht get
- ipfs dht provide
- ipfs dht put
- ipfs dht query
- ipfs diag
- ipfs diag cmds
- ipfs diag cmds clear
- ipfs diag cmds set-time
- ipfs diag sys
- ipfs dns
- ipfs file
- ipfs file ls
- ipfs files
- ipfs files chcid
- ipfs files cp
- ipfs files flush
- ipfs files ls
- ipfs files mkdir
- ipfs files mv
- ipfs files read
- ipfs files rm
- ipfs files stat
- ipfs files write
- ipfs filestore
- ipfs filestore dups
- ipfs filestore ls
- ipfs filestore verify
- ipfs get
- ipfs id
- ipfs init
- ipfs key
- ipfs key gen
- ipfs key list
- ipfs key rename
- ipfs key rm
- ipfs log
- ipfs log level
- ipfs log ls
- ipfs log tail
- ipfs ls
- ipfs mount
- ipfs name
- ipfs name publish
- ipfs name pubsub
- ipfs name pubsub cancel
- ipfs name pubsub state
- ipfs name pubsub subs
- ipfs name resolve
- ipfs object
- ipfs object data
- ipfs object diff
- ipfs object get
- ipfs object links
- ipfs object new
- ipfs object patch
- ipfs object patch add-link
- ipfs object patch append-data
- ipfs object patch rm-link
- ipfs object patch set-data
- ipfs object put
- ipfs object stat
- ipfs p2p
- ipfs p2p listener
- ipfs p2p listener close
- ipfs p2p listener ls
- ipfs p2p listener open
- ipfs p2p stream
- ipfs p2p stream close
- ipfs p2p stream dial
- ipfs p2p stream ls
- ipfs pin
- ipfs pin add
- ipfs pin ls
- ipfs pin rm
- ipfs pin update
- ipfs pin verify
- ipfs ping
- ipfs pubsub
- ipfs pubsub ls
- ipfs pubsub peers
- ipfs pubsub pub
- ipfs pubsub sub
- ipfs refs
- ipfs refs local
- ipfs repo
- ipfs repo fsck
- ipfs repo gc
- ipfs repo stat
- ipfs repo verify
- ipfs repo version
- ipfs resolve
- ipfs shutdown
- ipfs stats
- ipfs stats bitswap
- ipfs stats bw
- ipfs stats repo
- ipfs swarm
- ipfs swarm addrs
- ipfs swarm addrs listen
- ipfs swarm addrs local
- ipfs swarm connect
- ipfs swarm disconnect
- ipfs swarm filters
- ipfs swarm filters add
- ipfs swarm filters rm
- ipfs swarm peers
- ipfs tar
- ipfs tar add
- ipfs tar cat
- ipfs update
- ipfs version
ipfs
USAGE
ipfs - Global p2p merkle-dag filesystem.
SYNOPSIS
ipfs [--config= | -c] [--debug= | -D] [--help=] [-h=] [--local= | -L] [--api=] ...
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.
--api string - Use a specific API instance (defaults to /ip4/127.0.0.1/tcp/5001).
--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 Add a file to IPFS
cat Show IPFS object data
get Download IPFS objects
ls List links from an object
refs 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 mountpoint
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
Use 'ipfs --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.
Use 'ipfs --help' for more information about each command.
ipfs add
USAGE
ipfs add ... - Add a file or directory to ipfs.
SYNOPSIS
ipfs add [--recursive | -r] [--quiet | -q] [--quieter | -Q] [--silent] [--progress | -p] [--trickle | -t] [--only-hash | -n] [--wrap-with-directory | -w] [--hidden | -H] [--chunker= | -s] [--pin=false] [--raw-leaves] [--nocopy] [--fscache] [--cid-version=] [--hash=] [--] ...
ARGUMENTS
... - The path to a file to be added to ipfs.
OPTIONS
-r, --recursive bool - Add directory paths recursively. Default: false.
-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.
-H, --hidden bool - Include files that are hidden. Only takes effect on recursive add.
-s, --chunker string - Chunking algorithm, size-[bytes] or rabin-[min]-[avg]-[max]. 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.
DESCRIPTION
Adds contents of to ipfs. Use -r to add directories.
Note that directories are added recursively, to form the ipfs
MerkleDAG.
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. The default is a fixed block size of
256 * 1024 bytes, 'size-262144'. Alternatively, you can use the
rabin chunker for content defined chunking by specifying
rabin-[min]-[avg]-[max] (where min/avg/max refer to the resulting
chunk sizes). Using other chunking strategies will produce
different hashes for the same file.
> 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
ipfs bitswap
USAGE
ipfs bitswap - Interact with the bitswap agent.
SYNOPSIS
ipfs bitswap
SUBCOMMANDS
ipfs bitswap ledger - 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 unwant ... - Remove a given block from your wantlist.
ipfs bitswap wantlist - Show blocks currently on the wantlist.
Use 'ipfs bitswap --help' for more information about each command.
ipfs bitswap ledger
USAGE
ipfs bitswap ledger - Show the current ledger for a peer.
SYNOPSIS
ipfs bitswap ledger [--]
ARGUMENTS
- 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
ipfs bitswap unwant
USAGE
ipfs bitswap unwant ... - Remove a given block from your wantlist.
SYNOPSIS
ipfs bitswap unwant [--] ...
ARGUMENTS
... - Key(s) to remove from your wantlist.
ipfs bitswap wantlist
USAGE
ipfs bitswap wantlist - Show blocks currently on the wantlist.
SYNOPSIS
ipfs bitswap wantlist [--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 is a base58 encoded
multihash.
SUBCOMMANDS
ipfs block get - Get a raw IPFS block.
ipfs block put - Store input as an IPFS block.
ipfs block rm ... - Remove IPFS block(s).
ipfs block stat - Print information of a raw IPFS block.
Use 'ipfs block --help' for more information about each command.
ipfs block get
USAGE
ipfs block get - Get a raw IPFS block.
SYNOPSIS
ipfs block get [--]
ARGUMENTS
- 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 is a base58 encoded multihash.
ipfs block put
USAGE
ipfs block put - Store input as an IPFS block.
SYNOPSIS
ipfs block put [--format= | -f] [--mhtype=] [--mhlen=] [--]
ARGUMENTS
- The data to be stored as an IPFS block.
OPTIONS
-f, --format string - cid format for blocks to be created with. Default: v0.
--mhtype string - multihash hash function. Default: sha2-256.
--mhlen int - multihash hash length. Default: -1.
DESCRIPTION
'ipfs block put' is a plumbing command for storing raw IPFS blocks.
It reads from stdin, and is a base58 encoded multihash.
ipfs block rm
USAGE
ipfs block rm ... - Remove IPFS block(s).
SYNOPSIS
ipfs block rm [--force | -f] [--quiet | -q] [--] ...
ARGUMENTS
... - 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 multihashs to remove.
ipfs block stat
USAGE
ipfs block stat - Print information of a raw IPFS block.
SYNOPSIS
ipfs block stat [--]
ARGUMENTS
- 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 []... - Add peers to the bootstrap list.
ipfs bootstrap list - Show peers in the bootstrap list.
ipfs bootstrap rm []... - Remove peers from the bootstrap list.
Use 'ipfs bootstrap --help' for more information about each command.
ipfs bootstrap add
USAGE
ipfs bootstrap add []... - Add peers to the bootstrap list.
SYNOPSIS
ipfs bootstrap add [--default] [--] [...]
ARGUMENTS
[]... - A peer to add to the bootstrap list (in the format '/')
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.
Use 'ipfs bootstrap add --help' for more information about each command.
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 '/'.
ipfs bootstrap rm
USAGE
ipfs bootstrap rm []... - Remove peers from the bootstrap list.
SYNOPSIS
ipfs bootstrap rm [--all] [--] [...]
ARGUMENTS
[]... - A peer to add to the bootstrap list (in the format '/')
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.
Use 'ipfs bootstrap rm --help' for more information about each command.
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 ... - Show IPFS object data.
SYNOPSIS
ipfs cat [--offset= | -o] [--length= | -l] [--] ...
ARGUMENTS
... - The path to the IPFS object(s) to be outputted.
OPTIONS
-o, --offset int - Byte offset to begin reading from.
-l, --length int - Maximum number of bytes to read.
DESCRIPTION
Displays the data contained by an IPFS or IPNS object(s) at the given path.
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 [] - Get and set ipfs config values.
SYNOPSIS
ipfs config [--bool] [--json] [--] []
ARGUMENTS
- The key of the config entry (e.g. "Addresses.API").
[] - 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 - Replace the config with .
ipfs config show - Output config file contents.
Use 'ipfs config --help' for more information about each command.
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
SUBCOMMANDS
ipfs config profile apply - Apply profile to config.
Use 'ipfs config profile --help' for more information about each command.
ipfs config profile apply
USAGE
ipfs config profile apply - Apply profile to config.
SYNOPSIS
ipfs config profile apply [--]
ARGUMENTS
- The profile to apply to the config.
ipfs config replace
USAGE
ipfs config replace - Replace the config with .
SYNOPSIS
ipfs config replace [--]
ARGUMENTS
- 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. 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] [--routing=] [--mount] [--writable] [--mount-ipfs=] [--mount-ipns=] [--unrestricted-api] [--disable-transport-encryption] [--enable-gc] [--manage-fdlimit=false] [--offline] [--migrate] [--enable-pubsub-experiment] [--enable-namesys-pubsub] [--enable-mplex-experiment=false]
OPTIONS
--init bool - Initialize ipfs with default settings if not already initialized.
--routing string - Overrides the routing option. Default: dht.
--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.
--offline bool - Run offline. Do not connect to the rest of the network but provide local API.
--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 - Add the experimental 'go-multiplex' stream muxer to libp2p on construction. Default: true.
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 shutdown 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. 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 get - Get a dag node from ipfs. ipfs dag put
ipfs dag resolve
USAGE ipfs dag resolve - Resolve ipld block SYNOPSIS ipfs dag resolve [--] ARGUMENTS - The path to resolve DESCRIPTION 'ipfs dag resolve' fetches a dag node from ipfs, prints it's address and remaining path.
ipfs dht
USAGE ipfs dht - Issue commands directly through the DHT. SYNOPSIS ipfs dht SUBCOMMANDS ipfs dht findpeer ... - Query the DHT for all of the multiaddresses associated with a Peer ID. ipfs dht findprovs ... - Find peers in the DHT that can provide a specific value, given a key. ipfs dht get ... - Given a key, query the DHT for its best value. ipfs dht provide ... - Announce to the network that you are providing given values. ipfs dht put - Write a key/value pair to the DHT. ipfs dht query ... - Find the closest Peer IDs to a given Peer ID by querying the DHT. Use 'ipfs dht --help' for more information about each command.
ipfs dht findpeer
USAGE ipfs dht findpeer ... - Query the DHT for all of the multiaddresses associated with a Peer ID. SYNOPSIS ipfs dht findpeer [--verbose | -v] [--] ... ARGUMENTS ... - 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 ... - Find peers in the DHT that can provide a specific value, given a key. SYNOPSIS ipfs dht findprovs [--verbose | -v] [--num-providers= | -n] [--] ... ARGUMENTS ... - 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 ... - Given a key, query the DHT for its best value. SYNOPSIS ipfs dht get [--verbose | -v] [--] ... ARGUMENTS ... - 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 DHT; 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 ... - Announce to the network that you are providing given values. SYNOPSIS ipfs dht provide [--verbose | -v] [--recursive | -r] [--] ... ARGUMENTS ... - 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 - Write a key/value pair to the DHT. SYNOPSIS ipfs dht put [--verbose | -v] [--] ARGUMENTS - The key to store the value at. - The value to store. OPTIONS -v, --verbose bool - Print extra information. DESCRIPTION Given a key of the form /foo/bar and a value of any form, this will write that value to the DHT 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 DHT internals, you likely want to be using 'ipfs name publish' instead of this. Value is arbitrary text. Standard input can be used to provide value. NOTE: A value may not exceed 2048 bytes.
ipfs dht query
USAGE ipfs dht query ... - Find the closest Peer IDs to a given Peer ID by querying the DHT. SYNOPSIS ipfs dht query [--verbose | -v] [--] ... ARGUMENTS ... - 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. Use 'ipfs diag --help' for more information about each command.
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
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
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 - Resolve DNS links. SYNOPSIS ipfs dns [--recursive | -r] [--] ARGUMENTS - The domain-name name to resolve. OPTIONS -r, --recursive bool - Resolve until the result is not a DNS link. 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. 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 ... - List directory contents for Unix filesystem objects. Use 'ipfs file --help' for more information about each command.
ipfs file ls
USAGE ipfs file ls ... - List directory contents for Unix filesystem objects. SYNOPSIS ipfs file ls [--] ... ARGUMENTS ... - 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. If possible, please use 'ipfs ls' instead.
ipfs files
USAGE ipfs files - Interact with unixfs files. SYNOPSIS ipfs files [--f=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. 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 running 'ipfs repo gc' concurrently with '--flush=false' operations. SUBCOMMANDS ipfs files chcid [] - Change the cid version or hash function of the root node of a given path. ipfs files cp - Copy files into mfs. ipfs files flush [] - Flush a given path's data to disk. ipfs files ls [] - List directories in the local mutable namespace. ipfs files mkdir - Make directories. ipfs files mv - Move files. ipfs files read - Read a file in a given mfs. ipfs files rm ... - Remove a file. ipfs files stat - Display file status. ipfs files write - Write to a mutable file in a given filesystem. Use 'ipfs files --help' for more information about each command.
ipfs files chcid
USAGE ipfs files chcid [] - Change the cid version or hash function of the root node of a given path. SYNOPSIS ipfs files chcid [--cid-version= | --cid-ver] [--hash=] [--] [] ARGUMENTS [] - 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 - Copy files into mfs. SYNOPSIS ipfs files cp [--] ARGUMENTS - Source object to copy. - Destination to copy object to.
ipfs files flush
USAGE ipfs files flush [] - Flush a given path's data to disk. SYNOPSIS ipfs files flush [--] [] ARGUMENTS [] - Path to flush. Default: '/'. DESCRIPTION Flush a given path to disk. This is only useful when other commands are run with the '--flush=false'.
ipfs files ls
USAGE ipfs files ls [] - List directories in the local mutable namespace. SYNOPSIS ipfs files ls [-l] [--] [] ARGUMENTS [] - Path to show listing for. Defaults to '/'. OPTIONS -l bool - Use long listing format. DESCRIPTION List directories in the local mutable namespace. 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 - Make directories. SYNOPSIS ipfs files mkdir [--parents | -p] [--cid-version= | --cid-ver] [--hash=] [--] ARGUMENTS - 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 - Move files. SYNOPSIS ipfs files mv [--] ARGUMENTS - Source file to move. - Destination path for file to be moved to. DESCRIPTION Move files around. Just like traditional unix mv. Example: $ ipfs files mv /myfs/a/b/c /myfs/foo/newc
ipfs files read
USAGE ipfs files read - Read a file in a given mfs. SYNOPSIS ipfs files read [--offset= | -o] [--count= | -n] [--] ARGUMENTS - Path to file to be read. OPTIONS -o, --offset int - Byte offset to begin reading from. -n, --count int - Maximum number of bytes to read. DESCRIPTION Read a specified number of bytes from a file at a given offset. By default, will read the entire file similar to unix cat. Examples: $ ipfs files read /test/hello hello
ipfs files rm
USAGE ipfs files rm ... - Remove a file. SYNOPSIS ipfs files rm [--recursive | -r] [--] ... ARGUMENTS ... - File to remove. OPTIONS -r, --recursive bool - Recursively remove 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 - Display file status. SYNOPSIS ipfs files stat [--format=] [--hash] [--size] [--with-local] [--] ARGUMENTS - Path to node to stat. OPTIONS --format string - Print statistics in given format. Allowed tokens: . Conflicts with other format options. Default: Size: CumulativeSize: ChildBlocks: Type: . --hash bool - Print only hash. Implies '--format='. Conflicts with other format options. --size bool - Print only size. Implies '--format='. 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 - Write to a mutable file in a given filesystem. SYNOPSIS ipfs files write [--offset= | -o] [--create | -e] [--truncate | -t] [--count= | -n] [--raw-leaves] [--cid-version= | --cid-ver] [--hash=] [--] ARGUMENTS - Path to write to. - Data to write. OPTIONS -o, --offset int - Byte offset to begin writing at. -e, --create bool - Create the file if it does not exist. -t, --truncate bool - Truncate the file to size zero before writing. -n, --count int - 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. Nonexistant intermediate directories will not be created. 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 is 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 propogated 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 /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 []... - List objects in filestore. ipfs filestore verify []... - Verify objects in filestore. Use 'ipfs filestore --help' for more information about each command.
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 []... - List objects in filestore. SYNOPSIS ipfs filestore ls [--file-order] [--] [...] ARGUMENTS []... - 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 is specified only list those specific objects, otherwise list all objects. The output is:
ipfs filestore verify
USAGE ipfs filestore verify []... - Verify objects in filestore. SYNOPSIS ipfs filestore verify [--file-order] [--] [...] ARGUMENTS []... - 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 is specified only verify those specific objects, otherwise verify all objects. The output is: Where 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: 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 - Download IPFS objects. SYNOPSIS ipfs get [--output=
ipfs id
USAGE ipfs id [] - Show ipfs node id info. SYNOPSIS ipfs id [--format= | -f] [--] [] ARGUMENTS [] - Peer.ID of node to look up. OPTIONS -f, --format string - Optional output format. 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: : The peers id. : Agent version. : Protocol version. : Public key. : Addresses (newline delimited). EXAMPLE: ipfs id Qmece2RkXhsKe5CRooNisBTh4SK119KrXXGmoK6V3kb8aH -f="n"
ipfs init
USAGE ipfs init [] - Initializes ipfs config file. SYNOPSIS ipfs init [--bits= | -b] [--empty-repo | -e] [--profile= | -p] [--] [] ARGUMENTS [] - Initialize with the given configuration. OPTIONS -b, --bits int - Number of bits to use in the generated RSA private key. Default: 2048. -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. Available profiles: 'server' - Disables local host discovery, recommended when running IPFS on machines with public IPv4 addresses. 'test' - Reduces external interference of IPFS daemon, this is useful when using the daemon in test environments. 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 gen - Create a new keypair ipfs key list - List all local keypairs ipfs key rename - Rename a keypair ipfs key rm ... - Remove a keypair Use 'ipfs key --help' for more information about each command.
ipfs key gen
USAGE ipfs key gen - Create a new keypair SYNOPSIS ipfs key gen [--type= | -t] [--size= | -s] [--] ARGUMENTS - name of key to create OPTIONS -t, --type string - type of the key to create [rsa, ed25519]. -s, --size int - size of the key to generate.
ipfs key list
USAGE ipfs key list - List all local keypairs SYNOPSIS ipfs key list [-l] OPTIONS -l bool - Show extra information about keys.
ipfs key rename
USAGE ipfs key rename - Rename a keypair SYNOPSIS ipfs key rename [--force | -f] [--] ARGUMENTS - name of key to rename - new name of the key OPTIONS -f, --force bool - Allow to overwrite an existing key.
ipfs key rm
USAGE ipfs key rm ... - Remove a keypair SYNOPSIS ipfs key rm [-l] [--] ... ARGUMENTS ... - names of keys to remove OPTIONS -l bool - Show extra information about keys.
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. SUBCOMMANDS ipfs log level - Change the logging level. ipfs log ls - List the logging subsystems. ipfs log tail - Read the event log. Use 'ipfs log --help' for more information about each command.
ipfs log level
USAGE ipfs log level - Change the logging level. SYNOPSIS ipfs log level [--] ARGUMENTS - The subsystem logging identifier. Use 'all' for all subsystems. - The log level, with 'debug' the most verbose and 'critical' the least verbose. One of: debug, info, warning, error, critical. 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 ... - List directory contents for Unix filesystem objects. SYNOPSIS ipfs ls [--headers | -v] [--resolve-type=false] [--] ... ARGUMENTS ... - 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. DESCRIPTION Displays the contents of an IPFS or IPNS object(s) at the given path, with the following format: The JSON output contains type information.
ipfs mount
USAGE ipfs mount - Mounts IPFS to the filesystem (read-only). SYNOPSIS ipfs mount [--ipfs-path= | -f] [--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 overriden 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 with your default name: > ipfs name publish /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy Publish an 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 - Publish IPNS names. ipfs name pubsub - IPNS pubsub management ipfs name resolve [] - Resolve IPNS names. Use 'ipfs name --help' for more information about each command.
ipfs name publish
USAGE ipfs name publish - Publish IPNS names. SYNOPSIS ipfs name publish [--resolve=false] [--lifetime= | -t] [--ttl=] [--key= | -k] [--] ARGUMENTS - ipfs path of the object to be published. OPTIONS --resolve bool - Resolve given path 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". --ttl string - Time duration this record should be cached for (caution: experimental). -k, --key string - Name of the key to be used or a valid PeerID, as listed by 'ipfs key list -l'. Default: Default: self.. 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 with your default name: > ipfs name publish /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy Publish an 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 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 - Cancel a name subscription ipfs name pubsub state - Query the state of IPNS pubsub ipfs name pubsub subs - Show current name subscriptions Use 'ipfs name pubsub --help' for more information about each command.
ipfs name pubsub cancel
USAGE ipfs name pubsub cancel - Cancel a name subscription SYNOPSIS ipfs name pubsub cancel [--] ARGUMENTS - 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
ipfs name resolve
USAGE ipfs name resolve [] - Resolve IPNS names. SYNOPSIS ipfs name resolve [--recursive | -r] [--nocache | -n] [--] [] ARGUMENTS [] - The IPNS name to resolve. Defaults to your node's peerID. OPTIONS -r, --recursive bool - Resolve until the result is not an IPNS name. -n, --nocache bool - Do not use cached entries. 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 - Output the raw bytes of an IPFS object. ipfs object diff - Display the diff between two ipfs objects. ipfs object get - Get and serialize the DAG node named by . ipfs object links - Output the links pointed to by the specified object. ipfs object new [] - Create a new object from an ipfs template. ipfs object patch - Create a new merkledag object based on an existing one. ipfs object put - Store input as a DAG object, print its key. ipfs object stat - Get stats for the DAG node named by . Use 'ipfs object --help' for more information about each command.
ipfs object data
USAGE ipfs object data - Output the raw bytes of an IPFS object. SYNOPSIS ipfs object data [--] ARGUMENTS - 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 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 - Display the diff between two ipfs objects. SYNOPSIS ipfs object diff [--verbose | -v] [--] ARGUMENTS - Object to diff against. - 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 - Get and serialize the DAG node named by . SYNOPSIS ipfs object get [--] ARGUMENTS - Key of the object to retrieve, in base58-encoded multihash format. 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 is a base58 encoded multihash. This command outputs data in the following encodings: * "protobuf" * "json" * "xml" (Specified by the "--encoding" or "--enc" flag)
ipfs object links
USAGE ipfs object links - Output the links pointed to by the specified object. SYNOPSIS ipfs object links [--headers | -v] [--] ARGUMENTS - 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 is a base58 encoded multihash.
ipfs object new
USAGE ipfs object new [] - Create a new object from an ipfs template. SYNOPSIS ipfs object new [--] [] ARGUMENTS [] - 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 ' 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 - Add a link to a given object. ipfs object patch append-data - Append data to the data segment of a dag node. ipfs object patch rm-link - Remove a link from an object. ipfs object patch set-data - Set the data field of an IPFS object. Use 'ipfs object patch --help' for more information about each command.
ipfs object patch add-link
USAGE ipfs object patch add-link - Add a link to a given object. SYNOPSIS ipfs object patch add-link [--create | -p] [--] ARGUMENTS - The hash of the node to modify. - Name of link to create. - 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 - Append data to the data segment of a dag node. SYNOPSIS ipfs object patch append-data [--] ARGUMENTS - The hash of the node to modify. - 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 - Remove a link from an object. SYNOPSIS ipfs object patch rm-link [--] ARGUMENTS - The hash of the node to modify. - Name of the link to remove. DESCRIPTION Removes a link by the given name from root.
ipfs object patch set-data
USAGE ipfs object patch set-data - Set the data field of an IPFS object. SYNOPSIS ipfs object patch set-data [--] ARGUMENTS - The hash of the node to modify. - 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 - Store input as a DAG object, print its key. SYNOPSIS ipfs object put [--inputenc=] [--datafieldenc=] [--pin] [--quiet | -q] [--] ARGUMENTS - 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 - Get stats for the DAG node named by . SYNOPSIS ipfs object stat [--] ARGUMENTS - Key of the object to retrieve, in base58-encoded multihash format. DESCRIPTION 'ipfs object stat' is a plumbing command to print DAG node statistics. 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 listener - P2P listener management. ipfs p2p stream - P2P stream management. Use 'ipfs p2p --help' for more information about each command.
ipfs p2p listener
– Forward p2p connections to a network multiaddr. Use ‘ipfs p2p listener –help’ for more information about each command.USAGE ipfs p2p listener - P2P listener management. SYNOPSIS ipfs p2p listener DESCRIPTION Create and manage listener p2p endpoints SUBCOMMANDS ipfs p2p listener close [] - Close active p2p listener. ipfs p2p listener ls - List active p2p listeners. ipfs p2p listener open
ipfs p2p listener close
USAGE ipfs p2p listener close [] - Close active p2p listener. SYNOPSIS ipfs p2p listener close [--all | -a] [--] [] ARGUMENTS [] - P2P listener protocol OPTIONS -a, --all bool - Close all listeners.
ipfs p2p listener ls
USAGE ipfs p2p listener ls - List active p2p listeners. SYNOPSIS ipfs p2p listener ls [--headers | -v] OPTIONS -v, --headers bool - Print table headers (HandlerID, Protocol, Local, Remote).
ipfs p2p listener open
– Forward p2p connections to a network multiaddr. SYNOPSIS ipfs p2p listener open [–] ARGUMENTS – Protocol identifier. – Request handling application address. DESCRIPTION Register a p2p connection handler and forward the connections to a specified address. Note that the connections originate from the ipfs daemon process.USAGE ipfs p2p listener open
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 [] - Close active p2p stream. ipfs p2p stream dial [] - Dial to a p2p listener. ipfs p2p stream ls - List active p2p streams. Use 'ipfs p2p stream --help' for more information about each command.
ipfs p2p stream close
USAGE ipfs p2p stream close [] - Close active p2p stream. SYNOPSIS ipfs p2p stream close [--all | -a] [--] [] ARGUMENTS [] - Stream HandlerID OPTIONS -a, --all bool - Close all streams.
ipfs p2p stream dial
USAGE ipfs p2p stream dial [] - Dial to a p2p listener. SYNOPSIS ipfs p2p stream dial [--] [] ARGUMENTS - Remote peer to connect to - Protocol identifier. [] - Address to listen for connection/s (default: /ip4/127.0.0.1/tcp/0). DESCRIPTION Establish a new connection to a peer service. When a connection is made to a peer service the ipfs daemon will setup one time TCP listener and return it's bind port, this way a dialing application can transparently connect to a p2p service.
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 (HagndlerID, Protocol, Local, Remote).
ipfs pin
USAGE ipfs pin - Pin (and unpin) objects to local storage. SYNOPSIS ipfs pin SUBCOMMANDS ipfs pin add ... - Pin objects to local storage. ipfs pin ls []... - List objects pinned to local storage. ipfs pin rm ... - Remove pinned objects from local storage. ipfs pin update - Update a recursive pin ipfs pin verify - Verify that recursive pins are complete. Use 'ipfs pin --help' for more information about each command.
ipfs pin add
USAGE ipfs pin add ... - Pin objects to local storage. SYNOPSIS ipfs pin add [--recursive=false] [--progress] [--] ... ARGUMENTS ... - 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 []... - List objects pinned to local storage. SYNOPSIS ipfs pin ls [--type= | -t] [--quiet | -q] [--] [...] ARGUMENTS []... - 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. 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= 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= 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 rm
USAGE ipfs pin rm ... - Remove pinned objects from local storage. SYNOPSIS ipfs pin rm [--recursive=false] [--] ... ARGUMENTS ... - 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 - Update a recursive pin SYNOPSIS ipfs pin update [--unpin=false] [--] ARGUMENTS - Path to old object. - Path to new object to be pinned. OPTIONS --unpin bool - Remove the old pin. Default: true. DESCRIPTION Updates one pin to another, making sure that all objects in the new pin are local. Then removes the old pin. This is an optimized version of adding the new pin and removing the old one.
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 ... - Send echo request packets to IPFS hosts. SYNOPSIS ipfs ping [--count= | -n] [--] ... ARGUMENTS ... - 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 [] - List peers we are currently pubsubbing with. ipfs pubsub pub ... - Publish a message to a given pubsub topic. ipfs pubsub sub - Subscribe to messages on a given topic. Use 'ipfs pubsub --help' for more information about each command.
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 [] - List peers we are currently pubsubbing with. SYNOPSIS ipfs pubsub peers [--] [] ARGUMENTS [] - 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 ... - Publish a message to a given pubsub topic. SYNOPSIS ipfs pubsub pub [--] ... ARGUMENTS - Topic to publish to. ... - 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 - Subscribe to messages on a given topic. SYNOPSIS ipfs pubsub sub [--discover] [--] ARGUMENTS - String name of topic to subscribe to. OPTIONS --discover bool - try to discover other peers subscribed to the same topic. 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 ... - List links (references) from an object. SYNOPSIS ipfs refs [--format=] [--edges | -e] [--unique | -u] [--recursive | -r] [--] ... ARGUMENTS ... - Path to the object(s) to list refs from. OPTIONS --format string - Emit edges with given format. Available tokens: . Default: . -e, --edges bool - Emit edge format: ` -> `. -u, --unique bool - Omit duplicate refs from output. -r, --recursive bool - Recursively list links of child nodes. DESCRIPTION Lists the hashes of all the links an IPFS or IPNS object(s) contains, with the following format: NOTE: List all references recursively by using the flag '-r'. SUBCOMMANDS ipfs refs local - List all local references. Use 'ipfs refs --help' for more information about each command.
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. Use 'ipfs repo --help' for more information about each command.
ipfs repo fsck
USAGE ipfs repo fsck - Remove repo lockfiles. SYNOPSIS ipfs repo fsck DESCRIPTION 'ipfs repo fsck' is a plumbing command that will remove repo and level db lockfiles, as well as the api file. This command can only run when no ipfs daemons are running.
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 [--human] OPTIONS --human bool - Output RepoSize in MiB. DESCRIPTION 'ipfs repo stat' is a plumbing command that will scan the local set of stored objects and print repo statistics. It outputs to stdout: NumObjects int Number of objects in the local repo. RepoPath string The path to the repo being currently used. RepoSize int Size in bytes that the repo is currently taking. 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 - Resolve the value of names to IPFS. SYNOPSIS ipfs resolve [--recursive | -r] [--] ARGUMENTS - The name to resolve. OPTIONS -r, --recursive bool - Resolve until the result is an IPFS name. 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 repo - Get stats for the currently used repo. Use 'ipfs stats --help' for more information about each command.
ipfs stats bitswap
USAGE ipfs stats bitswap - Show some diagnostic information on the bitswap agent. SYNOPSIS ipfs stats bitswap
ipfs stats bw
USAGE ipfs stats bw - Print ipfs bandwidth information. SYNOPSIS ipfs stats bw [--peer= | -p] [--proto= | -t] [--poll] [--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 repo
USAGE ipfs stats repo - Get stats for the currently used repo. SYNOPSIS ipfs stats repo [--human] OPTIONS --human bool - Output RepoSize in MiB. DESCRIPTION 'ipfs repo stat' is a plumbing command that will scan the local set of stored objects and print repo statistics. It outputs to stdout: NumObjects int Number of objects in the local repo. RepoPath string The path to the repo being currently used. RepoSize int Size in bytes that the repo is currently taking. Version string The repo version.
ipfs swarm
… – Open connection to a given address. ipfs swarm disconnect … – Close connection to a given address. ipfs swarm filters – Manipulate address filters. ipfs swarm peers – List peers with open connections. Use ‘ipfs swarm –help’ for more information about each command.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
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. Use 'ipfs swarm addrs --help' for more information about each command.
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
… – Open connection to a given address. SYNOPSIS ipfs swarm connect [–] … ARGUMENTS … – 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/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJUSAGE ipfs swarm connect
ipfs swarm disconnect
… – Close connection to a given address. SYNOPSIS ipfs swarm disconnect [–] … ARGUMENTS … – 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/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ The disconnect is not permanent; if ipfs needs to talk to that address later, it will reconnect.USAGE ipfs swarm disconnect
ipfs swarm filters
… – Add an address filter. ipfs swarm filters rm … – Remove an address filter. Use ‘ipfs swarm filters –help’ for more information about each command.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
ipfs swarm filters add
… – Add an address filter. SYNOPSIS ipfs swarm filters add [–] … ARGUMENTS … – Multiaddr to filter. DESCRIPTION ‘ipfs swarm filters add’ will add an address filter to the daemons swarm. Filters applied this way will not persist daemon reboots, to achieve that, add your filters to the ipfs config file.USAGE ipfs swarm filters add
ipfs swarm filters rm
… – Remove an address filter. SYNOPSIS ipfs swarm filters rm [–] … ARGUMENTS … – Multiaddr filter to remove. DESCRIPTION ‘ipfs swarm filters rm’ will remove an address filter from the daemons swarm. Filters removed this way will not persist daemon reboots, to achieve that, remove your filters from the ipfs config file.USAGE ipfs swarm filters rm
ipfs swarm peers
USAGE ipfs swarm peers - List peers with open connections. SYNOPSIS ipfs swarm peers [--verbose | -v] [--streams] [--latency] 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. 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 - Import a tar file into ipfs. ipfs tar cat - Export a tar file from IPFS. Use 'ipfs tar --help' for more information about each command.
ipfs tar add
USAGE ipfs tar add - Import a tar file into ipfs. SYNOPSIS ipfs tar add [--] ARGUMENTS - 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 - Export a tar file from IPFS. SYNOPSIS ipfs tar cat [--] ARGUMENTS - ipfs path of archive to export. DESCRIPTION 'ipfs tar cat' will export a tar file from a previously imported one in IPFS.
ipfs update
NAME: ipfs-update - Update ipfs. USAGE: ipfs-update [global options] command [command options] [arguments...] VERSION: 1.5.1 COMMANDS: versions Print out all available versions. version Print out currently installed version. install Install a version of ipfs. stash stashes copy of currently installed ipfs binary revert Revert to previously installed version of ipfs. fetch Fetch a given version of ipfs. Default: latest. help, h Shows a list of commands or help for one command GLOBAL OPTIONS: --verbose Print verbose output. --distpath value specify the distributions build to use --help, -h show help --version, -v print the version
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.