mirror of
https://github.com/ipfs/kubo.git
synced 2026-02-22 19:07:48 +08:00
140cd1fd1b
We now consider debugerrors harmful: we've run into cases where debugerror.Wrap() hid valuable error information (err == io.EOF?). I've removed them from the main code, but left them in some tests. Go errors are lacking, but unfortunately, this isn't the solution. It is possible that debugerros.New or debugerrors.Errorf should remain still (i.e. only remove debugerrors.Wrap) but we don't use these errors often enough to keep.
116 lines
1.7 KiB
Go
116 lines
1.7 KiB
Go
package assets
|
|
|
|
var Init_doc_quick_start = `# 0.1 - Quick Start
|
|
|
|
This is a set of short examples with minmal explanation. It is meant as
|
|
a "quick start". Soon, we'll write a longer tour :-)
|
|
|
|
|
|
Add a file to ipfs:
|
|
|
|
echo "hello world" >hello
|
|
ipfs add hello
|
|
|
|
|
|
View it:
|
|
|
|
ipfs cat <the-hash-you-got-here>
|
|
|
|
|
|
Try a directory:
|
|
|
|
mkdir foo
|
|
mkdir foo/bar
|
|
echo "baz" > foo/baz
|
|
echo "baz" > foo/bar/baz
|
|
ipfs add -r foo
|
|
|
|
|
|
View things:
|
|
|
|
ipfs ls <the-hash-here>
|
|
ipfs ls <the-hash-here>/bar
|
|
ipfs cat <the-hash-here>/baz
|
|
ipfs cat <the-hash-here>/bar/baz
|
|
ipfs cat <the-hash-here>/bar
|
|
ipfs ls <the-hash-here>/baz
|
|
|
|
|
|
References:
|
|
|
|
ipfs refs <the-hash-here>
|
|
ipfs refs -r <the-hash-here>
|
|
ipfs refs --help
|
|
|
|
|
|
Get:
|
|
|
|
ipfs get <the-hash-here> foo2
|
|
diff foo foo2
|
|
|
|
|
|
Objects:
|
|
|
|
ipfs object get <the-hash-here>
|
|
ipfs object get <the-hash-here>/foo2
|
|
ipfs object --help
|
|
|
|
|
|
Pin + GC:
|
|
|
|
ipfs pin -r <the-hash-here>
|
|
ipfs gc
|
|
ipfs ls <the-hash-here>
|
|
ipfs unpin -r <the-hash-here>
|
|
ipfs gc
|
|
|
|
|
|
Daemon:
|
|
|
|
ipfs daemon (in another terminal)
|
|
ipfs id
|
|
|
|
|
|
Network:
|
|
|
|
(must be online)
|
|
ipfs swarm peers
|
|
ipfs id
|
|
ipfs cat <hash-of-remote-object>
|
|
|
|
|
|
Mount:
|
|
|
|
(warning: fuse is finicky!)
|
|
ipfs mount
|
|
cd /ipfs/<
|
|
|
|
|
|
Tool:
|
|
|
|
ipfs version
|
|
ipfs update
|
|
ipfs commands
|
|
ipfs config --help
|
|
open http://localhost:5001/webui
|
|
|
|
|
|
Browse:
|
|
|
|
webui:
|
|
|
|
http://localhost:5001/webui
|
|
|
|
video:
|
|
|
|
http://localhost:8080/ipfs/QmVc6zuAneKJzicnJpfrqCH9gSy6bz54JhcypfJYhGUFQu/play#/ipfs/QmTKZgRNwDNZwHtJSjCp6r5FYefzpULfy37JvMt9DwvXse
|
|
|
|
images:
|
|
|
|
http://localhost:8080/ipfs/QmZpc3HvfjEXvLWGQPWbHk3AjD5j8NEN4gmFN8Jmrd5g83/cs
|
|
|
|
markdown renderer app:
|
|
|
|
http://localhost:8080/ipfs/QmX7M9CiYXjVeFnkfVGf3y5ixTZ2ACeSGyL1vBJY1HvQPp/mdown
|
|
`
|