Add some documentation to `ipfs urlstore add` command.
License: MIT Signed-off-by: Kevin Atkinson <k@kevina.org>
Kevin Atkinson committed
Jun 26, 2018 at 15:43 UTC
0e2444428042023dfeca787d532dad5bc54a1778
1 file changed
+19
core/commands/urlstore.go
+19
@@ -24,6 +24,25 @@ var UrlStoreCmd = &cmds.Command{
24
}
25
26
var urlAdd = &cmds.Command{
27
+ Helptext: cmdkit.HelpText{
28
+ Tagline: "Add URLs via urlstore.",
29
+ LongDescription: `
30
+Add URLs to ipfs without storing the data locally.
31
+
32
+The URL provided must be stable and ideally on a web server under your
33
+control.
34
+
35
+The file is added using raw-leaves but otherwise using the default
36
+settings for 'ipfs add'.
37
+
38
+The file is not pinned, so this command should be followed by an 'ipfs
39
+pin add'.
40
+
41
+This command is considered temporary until a better solution can be
42
+found. It may disappear or the semantics can change at any
43
+time.
44
+`,
45
+ },
46
Arguments: []cmdkit.Argument{
47
cmdkit.StringArg("url", true, false, "URL to add to IPFS"),
48
},