How to Use the Command 'ipfs' (with Examples)

The InterPlanetary File System (IPFS) is an innovative peer-to-peer hypermedia protocol designed to make the web more open, resilient, and efficient. By using content-addressed data, IPFS decentralizes the web, allowing users to distribute and access files without relying on a single server. This transformative approach reimagines the internet with enhanced performance and security by making it possible to serve content from numerous sources simultaneously. Below are various use cases illustrating how you can leverage the IPFS command in practical scenarios.

Use case 1: Add a File from Local to the Filesystem, Pin It and Print the Relative Hash

Code:

ipfs add path/to/file

Motivation:

This use case is essential for users who wish to upload a file from their local system to IPFS, ensuring it’s easily accessible by others. Pinning a file means it will be stored on your local node and remain available even if other nodes decide not to store it, maintaining its availability on the network.

Explanation:

• ipfs: Invokes the IPFS command-line interface.
• add: This command adds files or directories to IPFS.
• path/to/file: The path to the file you wish to add. Replace this with the actual path to your file.

Example Output:

added Qme6KpZ9pscx3my1f3LCjzn1Q4Khy4QYkzdnxxefTZwvPad myfile.txt

The hash Qme6KpZ9pscx3my1f3LCjzn1Q4Khy4QYkzdnxxefTZwvPad is a unique identifier for the file in IPFS.

Use case 2: Add a Directory and Its Files Recursively from Local to the Filesystem and Print the Relative Hash

Code:

ipfs add -r path/to/directory

Motivation:

When working with multiple files organized in directories, it’s often more efficient to add the entire directory to IPFS. This is helpful for developers or researchers managing datasets, projects, or webpages consisting of numerous files.

Explanation:

• ipfs add -r: The -r flag indicates that the add command should process directories recursively.
• path/to/directory: The path to the directory you want to add. This command will include all nested files and subdirectories.

Example Output:

added QmbWqxBEKC3P8tqsKc98fm8aafUoTsuD8ftDvg2uUnzKfj directoryname

Use case 3: Save a Remote File and Give It a Name but Not Pin It

Code:

ipfs get hash -o path/to/file

Motivation:

This command is used to download content from the IPFS network without pinning it to your local storage. It’s beneficial for retrieving files temporarily or for accessing data without keeping a permanent local record, saving storage space.

Explanation:

• ipfs get: The command to fetch files or directories from IPFS using their hash.
• hash: The unique content identifier you want to retrieve from IPFS.
• -o path/to/file: The -o flag specifies the output path where the file will be saved locally.

Example Output:

Saving file to path/to/downloadedfile

Use case 4: Pin a Remote File Locally

Code:

ipfs pin add hash

Motivation:

Pinning a file ensures it stays in your local repository, meaning your node keeps hosting it even if other nodes remove it. This is crucial for ensuring important data remains readily accessible, supporting distributed backups and decentralized applications.

Explanation:

• ipfs pin add: Command to pin a file or directory, ensuring it remains in local storage.
• hash: The hash of the content you want to pin.

Example Output:

pinned Qme6KpZ9pscx3my1f3LCjzn1Q4Khy4, recursion=free

Use case 5: Display Pinned Files

Code:

ipfs pin ls

Motivation:

Listing pinned files helps users manage their storage by checking which files and directories are currently pinned. This is essential for administration and housekeeping tasks, ensuring users have an overview of their stored data.

Explanation:

• ipfs pin ls: The command to list all pinned files and directories in your local IPFS repository.

Example Output:

Qme6KpZ9pscx3my1f3LCjzn1Q4Khy4 recursive
QmYwAPJzv5CZsnAztbCQg2VgGUVZfLM3RLMBcbxjBRYeaT indirect

Use case 6: Unpin a File from Local Storage

Code:

ipfs pin rm hash

Motivation:

Sometimes it becomes necessary to unpin files to free up space or because the data is no longer needed. This action prevents your local storage from being unnecessarily burdened with outdated or redundant data.

Explanation:

• ipfs pin rm: Command to remove a pin from a specified file or directory.
• hash: The hash of the content you wish to unpin.

Example Output:

unpinned Qme6KpZ9pscx3my1f3LCjzn1Q4Khy4

Use case 7: Remove Unpinned Files from Local Storage

Code:

ipfs repo gc

Motivation:

Running a garbage collection process is vital for maintaining efficient use of storage space. After unpinning files, this command removes any data no longer pinned, which helps services and applications manage storage intelligently.

Explanation:

• ipfs repo gc: Executes a garbage collection in the IPFS repository, cleaning up leftover data that’s not pinned.

Example Output:

removed Qme6KpZ9pscx3my1f3LCjzn1Q4Khy4

Conclusion

The IPFS command suite offers robust functionality for managing and distributing files in a decentralized manner, supporting the vision of a more open and resilient web. By incorporating these commands into your processes, you can efficiently manage data, enhance content accessibility, and embrace the decentralized future of the internet.