peer-cli v1.0.5
Peer CLI
Swiss Army knife for the IPFS.
Install
npm install -g peer-cliFeatures
Upload File/Dir To The IPFS
You can easily upload file or directory to the IPFS.
With fuzzy search, you can easily find the file you want to upload to the IPFS. Also, progress bar is shown while uploading.
Show/Save File/Dir Contents from the IPFS
You can easily show/save file or directory contents from the IPFS with given CID. Also, you can save the listed contents to your local file system.
List in the IPFS
You can easily list file or directory contents in the IPFS with given CID.
- If the given CID is a file, you can either save the file, or show the file contents.
- If the given CID is a directory, you can save the contents to your local file system, or navigate to the directory.
Navigate in IPFS MFS
Because files in IPFS are content-addressed and immutable, they can be complicated to edit. Mutable File System (MFS) is a tool built into IPFS that lets you treat files like you would a regular name-based filesystem — you can add, remove, move, and edit MFS files and have all the work of updating links and hashes taken care of for you (Source).
This feature lets you easily manipulate files in the IPFS MFS like you are using Unix shell! The commands are very similar, thus you will not have any difficulty using them.
Available commands are:
(...) indicates that the command can take multiple arguments. (e.g.
lscan take multiple paths)
| Command | Options | Explanation |
|---|---|---|
| ls | optional: [path, ...] | List directory contents |
| cd | [path] | Change directory |
| pwd | Output the current working directory | |
| mkdir | [path, ...] | Make directory |
| rm | [path, ...] | Remove file or directory |
| stat | [path, ...] | Get file or directory statistics |
| flush | [path, ...] | Flush a given path's data to the disk |
| read | [path, ...] | Read a file |
| cat | [path, ...] | Alias for read |
| touch | [path, ...] | Update the mtime of a file or directory |
| write | [path] | Write to an MFS path |
| open | [path] | Alias for write |
| cp | [path] [to] | Copy files from one location to another |
| mv | [path] [to] | Move files from one location to another |
| help | optional: [command, ...] | Show help |
| man | optional: [command, ...] | Alias for help |
| clear | Clear the screen | |
| exit | Exit the MFS shell |
