object: Added a synopsis
Matt Bell committed
Nov 13, 2014 at 23:23 UTC
4eaf38c6bae2fe00ff2c8644a9c8251293f8ff63
1 file changed
+10
-2
core/commands2/object.go
+10
-2
@@ -25,8 +25,16 @@ type Node struct {
25
26
var objectCmd = &cmds.Command{
27
Helptext: cmds.HelpText{
28
- Tagline: "Interact with ipfs objects",
29
- ShortDescription: "'ipfs object' is a plumbing command used to manipulate DAG objects directly.",
28
+ Tagline: "Interact with ipfs objects",
29
+ ShortDescription: `
30
+'ipfs object' is a plumbing command used to manipulate DAG objects
31
+directly.`,
32
+ Synopsis: `
33
+ipfs object get <key> - Get the DAG node named by <key>
34
+ipfs object put <data> <encoding> - Stores input, outputs its key
35
+ipfs object data <key> - Outputs raw bytes in an object
36
+ipfs object links <key> - Outputs links pointed to by object
37
+`,
38
},
39
40
Subcommands: map[string]*cmds.Command{