add more helptext to dag commands
License: MIT Signed-off-by: Jeromy <why@ipfs.io>
Jeromy committed
Oct 29, 2016 at 18:03 UTC
c6a273fd05175dadd43d0fb40f00fed6de0c8112
1 file changed
+14
-2
core/commands/dag/dag.go
+14
-2
@@ -14,8 +14,13 @@ import (
14
15
var DagCmd = &cmds.Command{
16
Helptext: cmds.HelpText{
17
- Tagline: "Interact with ipld dag objects.",
18
- ShortDescription: ``,
17
+ Tagline: "Interact with ipld dag objects.",
18
+ ShortDescription: `
19
+'ipfs dag' is used for creating and manipulating dag objects.
20
+
21
+This subcommand is currently an experimental feature, but it is intended
22
+to deprecate and replace the existing 'ipfs object' command moving forward.
23
+ `,
24
},
25
Subcommands: map[string]*cmds.Command{
26
"put": DagPutCmd,
@@ -30,6 +35,10 @@ type OutputObject struct {
35
var DagPutCmd = &cmds.Command{
36
Helptext: cmds.HelpText{
37
Tagline: "Add a dag node to ipfs.",
38
+ ShortDescription: `
39
+'ipfs dag put' accepts input from a file or stdin and parses it
40
+into an object of the specified format.
41
+`,
42
},
43
Arguments: []cmds.Argument{
44
cmds.FileArg("object data", true, false, "The object to put").EnableStdin(),
@@ -91,6 +100,9 @@ var DagPutCmd = &cmds.Command{
100
var DagGetCmd = &cmds.Command{
101
Helptext: cmds.HelpText{
102
Tagline: "Get a dag node from ipfs.",
103
+ ShortDescription: `
104
+'ipfs dag get' fetches a dag node from ipfs and prints it out in the specifed format.
105
+`,
106
},
107
Arguments: []cmds.Argument{
108
cmds.StringArg("cid", true, false, "The cid of the object to get").EnableStdin(),