diff --git a/src/ipfs.io/docs/commands/cmdref.md b/src/ipfs.io/docs/commands/cmdref.md index 06771de1..53ae0390 100644 --- a/src/ipfs.io/docs/commands/cmdref.md +++ b/src/ipfs.io/docs/commands/cmdref.md @@ -1,9 +1,13 @@ # ipfs command reference -generated on 2015-02-16 05:07:29.025901 +generated on 2016-02-23 14:41:10.728008 - [ipfs](#ipfs) - [ipfs add](#ipfs-add) +- [ipfs bitswap](#ipfs-bitswap) +- [ipfs bitswap stat](#ipfs-bitswap-stat) +- [ipfs bitswap unwant](#ipfs-bitswap-unwant) +- [ipfs bitswap wantlist](#ipfs-bitswap-wantlist) - [ipfs block](#ipfs-block) - [ipfs block get](#ipfs-block-get) - [ipfs block put](#ipfs-block-put) @@ -22,9 +26,15 @@ generated on 2015-02-16 05:07:29.025901 - [ipfs dht](#ipfs-dht) - [ipfs dht findpeer](#ipfs-dht-findpeer) - [ipfs dht findprovs](#ipfs-dht-findprovs) +- [ipfs dht get](#ipfs-dht-get) +- [ipfs dht put](#ipfs-dht-put) - [ipfs dht query](#ipfs-dht-query) - [ipfs diag](#ipfs-diag) - [ipfs diag net](#ipfs-diag-net) +- [ipfs diag sys](#ipfs-diag-sys) +- [ipfs dns](#ipfs-dns) +- [ipfs file](#ipfs-file) +- [ipfs file ls](#ipfs-file-ls) - [ipfs get](#ipfs-get) - [ipfs id](#ipfs-id) - [ipfs init](#ipfs-init) @@ -40,6 +50,8 @@ generated on 2015-02-16 05:07:29.025901 - [ipfs object data](#ipfs-object-data) - [ipfs object get](#ipfs-object-get) - [ipfs object links](#ipfs-object-links) +- [ipfs object new](#ipfs-object-new) +- [ipfs object patch](#ipfs-object-patch) - [ipfs object put](#ipfs-object-put) - [ipfs object stat](#ipfs-object-stat) - [ipfs pin](#ipfs-pin) @@ -51,68 +63,127 @@ generated on 2015-02-16 05:07:29.025901 - [ipfs refs local](#ipfs-refs-local) - [ipfs repo](#ipfs-repo) - [ipfs repo gc](#ipfs-repo-gc) +- [ipfs resolve](#ipfs-resolve) +- [ipfs stats](#ipfs-stats) +- [ipfs stats bw](#ipfs-stats-bw) - [ipfs swarm](#ipfs-swarm) - [ipfs swarm addrs](#ipfs-swarm-addrs) +- [ipfs swarm addrs local](#ipfs-swarm-addrs-local) - [ipfs swarm connect](#ipfs-swarm-connect) - [ipfs swarm disconnect](#ipfs-swarm-disconnect) +- [ipfs swarm filters](#ipfs-swarm-filters) +- [ipfs swarm filters add](#ipfs-swarm-filters-add) +- [ipfs swarm filters rm](#ipfs-swarm-filters-rm) - [ipfs swarm peers](#ipfs-swarm-peers) +- [ipfs tar](#ipfs-tar) +- [ipfs tar add](#ipfs-tar-add) +- [ipfs tar cat](#ipfs-tar-cat) - [ipfs tour](#ipfs-tour) - [ipfs tour list](#ipfs-tour-list) - [ipfs tour next](#ipfs-tour-next) - [ipfs tour restart](#ipfs-tour-restart) - [ipfs update](#ipfs-update) -- [ipfs update check](#ipfs-update-check) -- [ipfs update log](#ipfs-update-log) - [ipfs version](#ipfs-version) ## ipfs ``` -USAGE: +ipfs - global p2p merkle-dag filesystem - ipfs - global p2p merkle-dag filesystem +OPTIONS: - ipfs [] [] ... + -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) - BASIC COMMANDS +SUBCOMMANDS: + + ipfs commands - List all available commands. + ipfs get - Download IPFS objects + ipfs id [] - Show IPFS Node ID info + ipfs dht - Issue commands directly through the DHT + ipfs daemon - Run a network-connected IPFS node + ipfs refs ... - Lists links (references) from an object + ipfs diag - Generates diagnostic reports + ipfs version - Shows ipfs version information + ipfs config [] - get and set IPFS config values + ipfs bitswap - A set of commands to manipulate the bitswap agent + ipfs swarm - swarm inspection tool + ipfs dns - DNS link resolver + ipfs file - Interact with ipfs objects representing Unix filesystems + ipfs log - Interact with the daemon log output + ipfs pin - Pin (and unpin) objects to local storage + ipfs block - Manipulate raw IPFS blocks + ipfs update []... - + ipfs ls ... - List links from an object. + ipfs mount - Mounts IPFS to the filesystem (read-only) + ipfs ping ... - send echo request packets to IPFS hosts + ipfs repo - Manipulate the IPFS repo + ipfs bootstrap - Show or edit the list of bootstrap peers + ipfs stats - Query IPFS statistics + ipfs tar - utility functions for tar files in ipfs + ipfs init - Initializes IPFS config file + ipfs cat ... - Show IPFS object data + ipfs add ... - Add an object to ipfs. + ipfs object - Interact with ipfs objects + ipfs name - IPFS namespace (IPNS) tool + ipfs resolve - Resolve the value of names to IPFS + ipfs tour [] - An introduction to IPFS + + Use 'ipfs --help' for more information about each command. +DESCRIPTION: + + BASIC COMMANDS + init Initialize ipfs local configuration add Add an object 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 - + file Interact with Unix filesystem objects + ADVANCED COMMANDS - + daemon Start a long-running daemon process mount Mount an ipfs read-only mountpoint + resolve Resolve any type of name name Publish or resolve IPNS names + dns Resolve DNS links pin Pin objects to local storage - gc Garbage collect unpinned objects - + repo gc Garbage collect unpinned objects + 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 ``` ## ipfs add @@ -126,11 +197,14 @@ ARGUMENTS: OPTIONS: - -r, -recursive bool - Add directory paths recursively - -q, -quiet bool - Write minimal output - -p, -progress bool - Stream progress data - -w, -wrap-with-directory bool - Wrap files with a directory object - -t, -trickle bool - Use trickle-dag format for dag generation + -r, --recursive bool - Add directory paths recursively + -q, --quiet bool - Write minimal 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 + -s, --chunker string - chunking algorithm to use DESCRIPTION: @@ -140,6 +214,50 @@ DESCRIPTION: remains to be implemented. ``` +## ipfs bitswap + +``` +ipfs bitswap - A set of commands to manipulate the bitswap agent + +SUBCOMMANDS: + + ipfs bitswap wantlist - Show blocks currently on the wantlist + ipfs bitswap stat - show some diagnostic information on the bitswap agent + ipfs bitswap unwant ... - Remove a given block from your wantlist + + Use 'ipfs bitswap --help' for more information about each command. +``` + +## ipfs bitswap stat + +``` +ipfs bitswap stat - show some diagnostic information on the bitswap agent +``` + +## ipfs bitswap unwant + +``` +ipfs bitswap unwant ... - Remove a given block from your wantlist + +ARGUMENTS: + + ... - key to remove from your wantlist +``` + +## ipfs bitswap wantlist + +``` +ipfs bitswap wantlist - Show blocks currently on the wantlist + +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 ``` @@ -147,9 +265,9 @@ ipfs block - Manipulate raw IPFS blocks SUBCOMMANDS: - ipfs block put - Stores input as an IPFS block ipfs block stat - Print information of a raw IPFS block ipfs block get - Get a raw IPFS block + ipfs block put - Stores input as an IPFS block Use 'ipfs block --help' for more information about each command. @@ -203,7 +321,7 @@ DESCRIPTION: 'ipfs block stat' is a plumbing command for retreiving information on raw ipfs blocks. It outputs the following to stdout: - + Key - the base58 encoded multihash Size - the size of the block in bytes ``` @@ -224,9 +342,9 @@ SUBCOMMANDS: 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 @@ -244,15 +362,15 @@ ARGUMENTS: OPTIONS: - -default bool - add default bootstrap nodes + --default bool - add default bootstrap nodes 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 @@ -280,14 +398,14 @@ ARGUMENTS: OPTIONS: - -all bool - Remove all bootstrap peers. + --all bool - Remove all bootstrap peers. 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 @@ -305,7 +423,7 @@ ARGUMENTS: DESCRIPTION: - Retrieves the object named by and outputs the data + Retrieves the object named by and outputs the data it contains. ``` @@ -314,6 +432,10 @@ DESCRIPTION: ``` ipfs commands - List all available commands. +OPTIONS: + + -f, --flags bool - Show command flags + DESCRIPTION: Lists all available commands (and subcommands) and exits. @@ -331,13 +453,14 @@ ARGUMENTS: OPTIONS: - -bool bool - Set a boolean value + --bool bool - Set a boolean value + --json bool - Parse stringified JSON SUBCOMMANDS: ipfs config show - Outputs the content of the config file ipfs config edit - Opens the config file for editing in $EDITOR - ipfs config replace - Replaces the config with `file> + ipfs config replace - Replaces the config with Use 'ipfs config --help' for more information about each command. @@ -346,16 +469,16 @@ 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 ~/.go-ipfs/datastore + + ipfs config datastore.path ~/.ipfs/datastore ``` ## ipfs config edit @@ -372,7 +495,7 @@ DESCRIPTION: ## ipfs config replace ``` -ipfs config replace - Replaces the config with `file> +ipfs config replace - Replaces the config with ARGUMENTS: @@ -402,12 +525,15 @@ ipfs daemon - Run a network-connected IPFS node OPTIONS: - -init bool - Initialize IPFS with default settings if not already initialized - -routing string - Overrides the routing option (dht, supernode) - -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) - -mount-ipns string - Path to the mountpoint for IPNS (if using --mount) + --init bool - Initialize IPFS with default settings if not already initialized + --routing string - Overrides the routing option (dht, supernode) + --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) + --mount-ipns string - Path to the mountpoint for IPNS (if using --mount) + --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 DESCRIPTION: @@ -416,6 +542,63 @@ DESCRIPTION: communicating with a daemon over the HTTP API. While the daemon is running, calls to 'ipfs' commands will be sent over the network to the daemon. + + 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 '["*"]' + 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, kill, quit, or otherwise stop the daemon, send a SIGTERM signal. + If it persists, send a second. This can be done by pressing Ctrl+C twice. + + 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 dht @@ -425,9 +608,11 @@ ipfs dht - Issue commands directly through the DHT SUBCOMMANDS: - ipfs dht query ... - Run a 'findClosestPeers' query through the DHT ipfs dht findprovs ... - Run a 'FindProviders' query through the DHT ipfs dht findpeer ... - Run a 'FindPeer' query through the DHT + ipfs dht get ... - Run a 'GetValue' query through the DHT + ipfs dht put - Run a 'PutValue' query through the DHT + ipfs dht query ... - Run a 'findClosestPeers' query through the DHT Use 'ipfs dht --help' for more information about each command. ``` @@ -453,13 +638,50 @@ ARGUMENTS: OPTIONS: - -v, -verbose bool - Write extra information + -v, --verbose bool - Write extra information DESCRIPTION: FindProviders will return a list of peers who are able to provide the value requested. ``` +## ipfs dht get + +``` +ipfs dht get ... - Run a 'GetValue' query through the DHT + +ARGUMENTS: + + ... - The key to find a value for + +OPTIONS: + + -v, --verbose bool - Write extra information + +DESCRIPTION: + + GetValue will return the value stored in the dht at the given key. +``` + +## ipfs dht put + +``` +ipfs dht put - Run a 'PutValue' query through the DHT + +ARGUMENTS: + + - The key to store the value at + - The value to store + +OPTIONS: + + -v, --verbose bool - Write extra information + +DESCRIPTION: + + PutValue will store the given key value pair in the dht. +``` + ## ipfs dht query ``` @@ -471,7 +693,7 @@ ARGUMENTS: OPTIONS: - -v, -verbose bool - Write extra information + -v, --verbose bool - Write extra information ``` ## ipfs diag @@ -482,6 +704,7 @@ ipfs diag - Generates diagnostic reports SUBCOMMANDS: ipfs diag net - Generates a network diagnostics report + ipfs diag sys - prints out system diagnostic information. Use 'ipfs diag --help' for more information about each command. ``` @@ -493,41 +716,128 @@ ipfs diag net - Generates a network diagnostics report OPTIONS: - -timeout string - diagnostic timeout duration - -vis string - output vis. one of: d3, dot + --vis string - output vis. one of: d3, dot DESCRIPTION: Sends out a message to each node in the network recursively requesting a listing of data about them including number of connected peers and latencies between them. - - The given timeout will be decremented 2s at every network hop, - ensuring peers try to return their diagnostics before the initiator's + + The given timeout will be decremented 2s at every network hop, + ensuring peers try to return their diagnostics before the initiator's timeout. If the timeout is too small, some peers may not be reached. 30s and 60s are reasonable timeout values, though network vary. The default timeout is 20 seconds. - + The 'vis' option may be used to change the output format. four formats are supported: * plain text - easy to read * d3 - json ready to be fed into d3view * dot - graphviz format - + The d3 format will output a json object ready to be consumed by the chord network viewer, available at the following hash: - + /ipfs/QmbesKpGyQGd5jtJFUGEB1ByPjNFpukhnKZDnkfxUiKn38 - + To view your diag output, 'ipfs add' the d3 vis output, and open the following link: - - https//ipfs.io/ipfs/QmbesKpGyQGd5jtJFUGEB1ByPjNFpukhnKZDnkfxUiKn38/chord# - + + http://gateway.ipfs.io/ipfs/QmbesKpGyQGd5jtJFUGEB1ByPjNFpukhnKZDnkfxUiKn38/chord# + The dot format can be fed into graphviz and other programs that consume the dot format to generate graphs of the network. ``` +## ipfs diag sys + +``` +ipfs diag sys - prints out system diagnostic information. + +DESCRIPTION: + + Prints out information about your computer to aid in easier debugging. +``` + +## ipfs dns + +``` +ipfs dns - DNS link resolver + +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: + + ipfs.io. TXT "dnslink=/ipfs/QmRzTuh2Lpuz7Gr39stNr6mTFdqAghsZec1JoUnfySUzcy ..." + + The resolver will give: + + > ipfs dns ipfs.io + /ipfs/QmRzTuh2Lpuz7Gr39stNr6mTFdqAghsZec1JoUnfySUzcy + + And with this DNS TXT record: + + ipfs.ipfs.io. TXT "dnslink=/dns/ipfs.io ..." + + The resolver will give: + + > ipfs dns ipfs.io + /dns/ipfs.io + > ipfs dns --recursive + /ipfs/QmRzTuh2Lpuz7Gr39stNr6mTFdqAghsZec1JoUnfySUzcy +``` + +## ipfs file + +``` +ipfs file - Interact with ipfs objects representing Unix filesystems + +SUBCOMMANDS: + + ipfs file ls ... - List directory contents for Unix-filesystem objects + + Use 'ipfs file --help' for more information about each command. + +DESCRIPTION: + + 'ipfs file' provides a familar interface to filesystems represtented + by IPFS objects that hides IPFS-implementation details like layout + objects (e.g. fanout and chunking). +``` + +## ipfs file ls + +``` +ipfs file ls ... - List directory contents for Unix-filesystem objects + +ARGUMENTS: + + ... - The path to the IPFS object(s) to list links from + +DESCRIPTION: + + Retrieves the object named by and displays the + contents. + + 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. +``` + ## ipfs get ``` @@ -539,20 +849,20 @@ ARGUMENTS: OPTIONS: - -o, -output string - The path where 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) + -o, --output string - The path where 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: - Retrieves the object named by and stores the data to disk. - + Retrieves the object named by and stores the data to disk. + By default, the output will be stored at ./, but an alternate path can be specified with '--output=' or '-o='. - + 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>'. ``` @@ -568,18 +878,19 @@ ARGUMENTS: OPTIONS: - -f, -format string - optional output format + -f, --format string - optional output format DESCRIPTION: Prints out information about the specified peer, if no peer is specified, prints out local peers info. - + ipfs id supports the format option for output with the following keys: : the peers id : agent version : protocol version : public key + : addresses (newline delimited) ``` ## ipfs init @@ -589,9 +900,9 @@ ipfs init - Initializes IPFS config file OPTIONS: - -b, -bits int - Number of bits to use in the generated RSA private key (defaults to 4096) - -p, -passphrase string - Passphrase for encrypting the private key - -f, -force bool - Overwrite existing config (if it exists) + -b, --bits int - Number of bits to use in the generated RSA private key (defaults to 2048) + -f, --force bool - Overwrite existing config (if it exists) + -e, --empty-repo bool - Don't add and pin help files to the local storage DESCRIPTION: @@ -605,8 +916,8 @@ ipfs log - Interact with the daemon log output SUBCOMMANDS: - ipfs log tail - Read the logs ipfs log level - Change the logging level + ipfs log tail - Read the logs Use 'ipfs log --help' for more information about each command. @@ -624,7 +935,7 @@ ipfs log level - Change the logging level ARGUMENTS: - the subsystem logging identifier. Use 'all' for all subsystems. - - one of: debug, info, notice, warning, error, critical + - one of: debug, info, warning, error, fatal, panic DESCRIPTION: @@ -651,11 +962,15 @@ ARGUMENTS: ... - The path to the IPFS object(s) to list links from +OPTIONS: + + -v, --headers bool - Print table headers (Hash, Name, Size) + DESCRIPTION: - Retrieves the object named by and displays the links + Retrieves the object named by and displays the links it contains, with the following format: - + ``` @@ -666,24 +981,24 @@ ipfs mount - Mounts IPFS to the filesystem (read-only) OPTIONS: - -f string - The path where IPFS should be mounted - -n string - The path where IPNS should be mounted + -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 (default: /ipfs and /ipns). All ipfs objects will be accessible under that directory. Note that the root will not be listable, as it is virtual. Access known paths directly. - - You may have to create /ipfs and /ipfs before using 'ipfs mount': - + + 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 @@ -694,7 +1009,7 @@ DESCRIPTION: QmWLdkp93sNxGRjnFHPaYg8tCQ35NBY3XPn6KiETd3Z4WR 12 bar > ipfs cat QmWLdkp93sNxGRjnFHPaYg8tCQ35NBY3XPn6KiETd3Z4WR baz - + # mount > ipfs daemon & > ipfs mount @@ -718,8 +1033,8 @@ ipfs name - IPFS namespace (IPNS) tool SUBCOMMANDS: - ipfs name publish [] - Publish an object to IPNS - ipfs name resolve [] - Gets the value currently published at an IPNS name + ipfs name publish - Publish an object to IPNS + ipfs name resolve [] - Gets the value currently published at an IPNS name Use 'ipfs name --help' for more information about each command. @@ -728,58 +1043,63 @@ 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 value of is your own identity public key. - - + + Examples: - - Publish a to your identity name: - - > ipfs name publish QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy - published name QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n to QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy - - Publish a to another public key: - - > ipfs name publish QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy - published name QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n to QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy - + + Publish an to your identity name: + + > ipfs name publish /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy + Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy + + Publish an to another public key: + + > ipfs name publish /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n + Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy + Resolve the value of your identity: - + > ipfs name resolve - QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy - + /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy + Resolve the value of another name: - + > ipfs name resolve QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n - QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy + /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy ``` ## ipfs name publish ``` -ipfs name publish [] - Publish an object to IPNS +ipfs name publish - Publish an object to IPNS ARGUMENTS: - [] - The IPNS name to publish to. Defaults to your node's peerID - - IPFS path of the obejct to be published at + - IPFS path of the obejct 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: 24hrs) + --ttl string - time duration this record should be cached for (caution: experimental) DESCRIPTION: IPNS is a PKI namespace, where names are the hashes of public keys, and the private key enables publishing new (signed) values. In publish, the default value of is your own identity public key. - + Examples: - - Publish a to your identity name: - - > ipfs name publish QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy - published name QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n to QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy - - Publish a to another public key: - - > ipfs name publish QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy - published name QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n to QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy + + Publish an to your identity name: + + > ipfs name publish /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy + Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy + + Publish an to another public key (not implemented): + + > ipfs name publish /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n + Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy ``` ## ipfs name resolve @@ -791,22 +1111,27 @@ 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 used 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 resolve, the default value of is your own identity public key. - - + + Examples: - + Resolve the value of your identity: - + > ipfs name resolve QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy - - Resolve te value of another name: - + + Resolve the value of another name: + > ipfs name resolve QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy ``` @@ -818,11 +1143,13 @@ ipfs object - Interact with ipfs objects SUBCOMMANDS: - ipfs object data - Outputs the raw bytes in an IPFS object - ipfs object links - Outputs the links pointed to by the specified object - ipfs object get - Get and serialize the DAG node named by - ipfs object put - Stores input as a DAG object, outputs its key - ipfs object stat - Get stats for the DAG node named by + ipfs object patch ... - Create a new merkledag object based on an existing one + ipfs object data - Outputs the raw bytes in an IPFS object + ipfs object links - Outputs the links pointed to by the specified object + ipfs object get - Get and serialize the DAG node named by + ipfs object put - Stores input as a DAG object, outputs its key + ipfs object stat - Get stats for the DAG node named by + ipfs object new [