跳到主要内容

IPFS 命令详解

ipfs init​

初始化一个新的 IPFS 节点是使用 IPFS 的第一步。ipfs init命令用于在本地创建一个 IPFS 仓库，并生成必要的配置文件和密钥对。

ipfs init

执行此命令后，系统会输出节点的 Peer ID 和初始配置。初始化过程会生成一个默认的配置文件，位于~/.ipfs/config，你可以根据需要进行修改。

示例​

$ ipfs init
initializing IPFS node at /home/user/.ipfs
generating 2048-bit RSA keypair...done
peer identity: QmExamplePeerID

ipfs add​

ipfs add命令用于将文件添加到 IPFS 网络。添加文件后，IPFS 会返回文件的内容标识符（CID），该 CID 可以用于在网络中检索该文件。

ipfs add <文件路径>

示例​

$ ipfs add example.txt
added QmExampleCID example.txt

此命令将example.txt文件添加到 IPFS，并返回其 CID。你可以使用该 CID 在任何 IPFS 节点上访问该文件。

ipfs cat​

ipfs cat命令用于通过 CID 检索和显示文件内容。这个命令类似于 Unix 中的cat命令，但它从 IPFS 网络中获取数据。

ipfs cat <CID>

示例​

$ ipfs cat QmExampleCID
Hello, IPFS!

该命令将显示 CID 为QmExampleCID的文件内容。

ipfs ls​

ipfs ls命令用于列出 CID 对应的对象的内容。如果 CID 指向一个目录，该命令会列出目录中的所有文件和子目录。

ipfs ls <CID>

示例​

$ ipfs ls QmExampleDirectoryCID
QmFile1CID  12345  file1.txt
QmFile2CID  67890  file2.txt

此命令显示了目录 CID 下包含的文件及其对应的 CID 和大小。

ipfs pin​

为了确保特定的 CID 在本地 IPFS 节点中被永久保存，可以使用ipfs pin命令进行固定。固定的内容不会被垃圾回收机制删除。

ipfs pin add <CID>

示例​

$ ipfs pin add QmExampleCID
pinning QmExampleCID

固定内容对于需要长期保存的重要数据非常有用，避免数据在节点重启或清理时丢失。

ipfs daemon​

ipfs daemon命令用于启动 IPFS 守护进程。这是 IPFS 节点在网络中运行和与其他节点通信的核心服务。

ipfs daemon

示例​

$ ipfs daemon
Initializing daemon...
API server listening on /ip4/127.0.0.1/tcp/5001
Gateway server listening on /ip4/127.0.0.1/tcp/8080

启动守护进程后，节点将开始连接到 IPFS 网络，并可以处理 API 请求和网关访问。

ipfs swarm​

ipfs swarm命令用于管理和查看 IPFS 节点的网络连接。常用的子命令包括connect和peers。

连接到另一个节点​

ipfs swarm connect <多地址>

示例​

$ ipfs swarm connect /ip4/192.168.1.10/tcp/4001/p2p/QmPeerID

查看当前连接的节点​

ipfs swarm peers

示例​

$ ipfs swarm peers
/ip4/192.168.1.10/tcp/4001/p2p/QmPeerID
/ip6/::1/tcp/4001/p2p/QmAnotherPeerID

通过swarm子命令，用户可以管理节点之间的连接，优化网络性能和数据传输效率。

ipfs config​

ipfs config命令用于查看和修改 IPFS 节点的配置。用户可以调整节点的行为和参数，以满足特定需求。

ipfs config <键> <值>

示例​

查看当前的配置：

$ ipfs config show

修改 API 地址：

$ ipfs config Addresses.API /ip4/127.0.0.1/tcp/5002

通过调整配置，用户可以自定义节点的网络设置、安全选项和其他参数，提升 IPFS 的使用体验。

ipfs version​

ipfs version命令用于显示当前安装的 IPFS 版本信息。这对于确保节点使用最新版本和进行故障排除非常有用。

ipfs version

示例​

$ ipfs version
ipfs version 0.8.0

了解 IPFS 版本有助于用户跟踪更新和兼容性，确保节点运行稳定。

ipfs repo​

ipfs repo命令用于管理 IPFS 仓库，包括检查、修复和备份仓库数据。

检查仓库状态​

ipfs repo stat

示例​

$ ipfs repo stat
Repo:         /home/user/.ipfs
Version:      10
StorageMax:   10 GiB

修复仓库​

ipfs repo repair

此命令在仓库出现问题时尝试修复数据，确保节点的正常运行。

ipfs key​

ipfs key命令用于管理 IPNS 密钥。通过创建和管理密钥，用户可以在 IPFS 网络中发布和更新内容。

创建新密钥​

ipfs key gen <名称> [选项]

示例​

$ ipfs key gen myKey
generating RSA keypair...done

列出所有密钥​

ipfs key list

示例​

$ ipfs key list
myKey

通过管理密钥，用户可以实现内容的安全发布和更新，提升 IPFS 的应用灵活性。

ipfs dag​

ipfs dag命令用于操作 IPFS 中的有向无环图（DAG）数据结构。它支持添加、获取和修改 DAG 节点。

获取 DAG 节点​

ipfs dag get <CID>

示例​

$ ipfs dag get QmDAGCID
{
  "name": "example",
  "value": 123
}

添加 DAG 节点​

ipfs dag put <文件>

示例​

$ ipfs dag put example.json
added QmNewDAGCID

DAG 操作对于构建复杂的数据结构和应用非常重要，提供了灵活的数据管理方式。

ipfs pin ls​

ipfs pin ls命令用于列出当前节点固定的所有 CID。这有助于用户了解哪些内容被保存在本地，避免数据丢失。

ipfs pin ls

示例​

$ ipfs pin ls
QmExampleCID
QmAnotherCID

通过定期查看固定的内容，用户可以有效管理存储资源，确保重要数据的持久性。

ipfs block​

ipfs block命令用于直接操作 IPFS 中的数据块。它支持添加、获取和删除块。

获取数据块​

ipfs block get <CID>

示例​

$ ipfs block get QmBlockCID
{"data":"example data"}

删除数据块​

ipfs block rm <CID>

示例​

$ ipfs block rm QmBlockCID
removed QmBlockCID

块操作适用于需要低级数据管理的高级用户，提供了更细粒度的控制。

ipfs mount​

ipfs mount命令用于将 IPFS 文件系统挂载到本地文件系统。这样，用户可以像访问本地文件一样访问 IPFS 内容。

ipfs mount <挂载点>

示例​

$ ipfs mount /mnt/ipfs

挂载后，用户可以通过/mnt/ipfs目录访问 IPFS 网络中的内容，简化了数据的交互和管理。

ipfs stats​

ipfs stats命令用于监控 IPFS 节点的性能和资源使用情况。它提供了实时的统计数据，有助于优化节点配置。

查看网络统计​

ipfs stats bw

示例​

$ ipfs stats bw
Download: 10 MB/s
Upload: 5 MB/s

查看代理统计​

ipfs stats repo

示例​

$ ipfs stats repo
Repo size: 2.5 GB
Num objects: 15000

通过监控统计数据，用户可以及时发现和解决性能瓶颈，提升 IPFS 节点的运行效率。

ipfs config edit​

ipfs config edit命令用于在默认编辑器中打开 IPFS 配置文件，便于用户手动修改配置。

ipfs config edit

示例​

$ ipfs config edit

此命令会打开配置文件，用户可以根据需求调整网络设置、安全选项和其他参数，定制 IPFS 节点的行为。

ipfs log​

ipfs log命令用于查看和管理 IPFS 守护进程的日志。日志记录了节点的运行状态和发生的事件，便于故障排除。

查看日志​

ipfs log tail

示例​

$ ipfs log tail
2024-04-27T12:00:00Z Initialized IPFS node
2024-04-27T12:05:00Z Added file example.txt with CID QmExampleCID

通过查看日志，用户可以了解节点的活动情况，快速定位和解决问题。

ipfs version​

ipfs version命令用于显示当前安装的 IPFS 版本信息，确保节点使用的是最新版本，并有助于兼容性检查。

ipfs version

示例​

$ ipfs version
ipfs version 0.12.2

定期检查 IPFS 版本，有助于获取最新功能和安全修复，保障节点的稳定运行。

实践中的 IPFS 命令应用​

在实际应用中，熟练掌握 IPFS 命令能够显著提升数据管理和分发的效率。例如，部署一个去中心化的内容管理系统，开发者可以使用ipfs add命令上传内容，通过ipfs pin确保数据持久存储，并利用ipfs daemon保持节点在线。同时，结合ipfs name publish和ipfs key命令，实现内容的动态更新和安全管理。

# 启动IPFS守护进程
ipfs daemon

# 添加文件到IPFS
ipfs add blog-post.md

# 固定文件以防止被垃圾回收
ipfs pin add QmBlogPostCID

# 发布到IPNS
ipfs name publish QmBlogPostCID
编辑此页
最后由 sumingcheng 于 更新