README
¶
ipfs-commands
Generate IPFS commands + api reference markdown, so we can add it to the website easily. See go-ipfs/Issue#785
Usage:
go get -v github.com/dborzov/ipfs-commands
cd $GOPATH/src/github.com/dborzov/ipfs-commands
ipfs-commands
et voila, we get the parsed template file from TEMPLATE.md in Stdout, like this:
IPFS command line tool commands
'ipfs repo' is a plumbing command used to manipulate the repo.
Adds contents of to ipfs. Use -r to add directories. Note that directories are added recursively, to form the ipfs MerkleDAG. A smarter partial add with a staging area (like git) remains to be implemented.
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.
'ipfs object' is a plumbing command used to manipulate DAG objects directly.
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.
Retrieves the object named by and outputs the data it contains.
ipfs config controls configuration variables. It works like 'git config'. The configuration values are stored in a config file inside your IPFS repository.
'ipfs log' contains utility commands to affect or read the logging output of a running daemon.
ipfs ping is a tool to test sending data to other nodes. It finds nodes via the routing system, send pings, wait for pongs, and print out round- trip latency information.
Retrieves the object named by and displays the link hashes it contains, with the following format:
Note: list all refs recursively with -r.
Returns the current version of ipfs and exits.
'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.
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.
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>'.
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
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':
sudo mkdir /ipfs /ipns sudo chown
whoami/ipfs /ipns ipfs daemon & ipfs mount
Lists all available commands (and subcommands) and exits.
Retrieves the object named by and displays the links it contains, with the following format:
ipfs update is a utility command used to check for updates and apply them.
Documentation
¶
There is no documentation for this package.
Source Files