Fix #6878: Improve MFS Cli documentation
Hector Sanjuan committed
Feb 7, 2020 at 14:55 UTC
da584b867923ffd89a5404625279601bfe54740e
1 file changed
+12
core/commands/files.go
+12
@@ -39,6 +39,18 @@ var FilesCmd = &cmds.Command{
39
Files is an API for manipulating IPFS objects as if they were a unix
40
filesystem.
41
42
+The files facility interacts with MFS (Mutable File System). MFS acts as a
43
+single, dynamic filesystem mount. MFS has a root CID which is transparently
44
+updated when a change happens (and can be checked with "ipfs files stat /").
45
+
46
+All files and folders within MFS are respected and will not be cleaned up
47
+during garbage collections. MFS is independent from the list of pinned items
48
+("ipfs pin ls"). Calls to "ipfs pin add" and "ipfs pin rm" do not affect
49
+content on MFS. Similarly, content added with "ipfs add" (which by default
50
+pins), is not added to MFS. Any content can be put into MFS with the command
51
+"ipfs files cp /ipfs/<cid> /mfs/path/".
52
+
53
+
54
NOTE:
55
Most of the subcommands of 'ipfs files' accept the '--flush' flag. It defaults
56
to true. Use caution when setting this flag to false. It will improve