Skip to content

Commit

Permalink
Fix #6878: Improve MFS Cli documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hsanjuan committed Feb 7, 2020
1 parent 28608f0 commit da584b8
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions core/commands/files.go
Expand Up @@ -39,6 +39,18 @@ var FilesCmd = &cmds.Command{
Files is an API for manipulating IPFS objects as if they were a unix
filesystem.
The files facility interacts with MFS (Mutable File System). MFS acts as a
single, dynamic filesystem mount. MFS has a root CID which is transparently
updated when a change happens (and can be checked with "ipfs files stat /").
All files and folders within MFS are respected and will not be cleaned up
during garbage collections. MFS is independent from the list of pinned items
("ipfs pin ls"). Calls to "ipfs pin add" and "ipfs pin rm" do not affect
content on MFS. Similarly, content added with "ipfs add" (which by default
pins), is not added to MFS. Any content can be put into MFS with the command
"ipfs files cp /ipfs/<cid> /mfs/path/".
NOTE:
Most of the subcommands of 'ipfs files' accept the '--flush' flag. It defaults
to true. Use caution when setting this flag to false. It will improve
Expand Down

0 comments on commit da584b8

Please sign in to comment.