IPFS

https://docs.ipfs.tech/
Admin
The InterPlanetary File System (IPFS) is a set of building blocks for a better web, offering open...
Tokens:204,698
Snippets:2,442
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Kubo on FreeBSD

Source: https://docs.ipfs.tech/install/command-line

Run the install script with doas privileges to install Kubo on FreeBSD.

```bash
doas bash install.sh

> Moved ./ipfs to /usr/local/bin
```

--------------------------------

### Install Kubo on Linux

Source: https://docs.ipfs.tech/install/command-line

Run the install script with sudo privileges to install Kubo to the system's PATH.

```bash
sudo bash install.sh

> Moved ./ipfs to /usr/local/bin
```

--------------------------------

### Install @helia/verified-fetch

Source: https://docs.ipfs.tech/how-to/replace-public-gateways-with-self-hosted-ipfs

Install the verified-fetch package for browser-based IPFS content retrieval.

```bash
npm install @helia/verified-fetch

```

--------------------------------

### Bash Command-Line Examples

Source: https://docs.ipfs.tech/community/contribute/grammar-formatting-and-style

Present command-line inputs and outputs using ```bash. Precede outputs with '>'. Separate input and output with an empty line. Examples can be truncated.

```bash
ping ipfs.io

> PING ipfs.io (209.94.90.1): 56 data bytes
> 64 bytes from 209.94.90.1: icmp_seq=0 ttl=53 time=15.830 ms
> 64 bytes from 209.94.90.1: icmp_seq=1 ttl=53 time=19.779 ms
> 64 bytes from 209.94.90.1: icmp_seq=2 ttl=53 time=20.778 ms
> 64 bytes from 209.94.90.1: icmp_seq=3 ttl=53 time=20.578 ms
> --- ipfs.io ping statistics ---
> 4 packets transmitted, 4 packets received, 0.0% packet loss
```

```bash
ping ipfs.io

> PING ipfs.io (209.94.90.1): 56 data bytes
> 64 bytes from 209.94.90.1: icmp_seq=0 ttl=53 time=15.830 ms
> ...
> 4 packets transmitted, 4 packets received, 0.0% packet loss
```

--------------------------------

### Install IPFS Desktop on Ubuntu with .deb

Source: https://docs.ipfs.tech/install/ipfs-desktop

Use this command to install the IPFS Desktop .deb package from the command line. Replace `[version]` with the actual package version.

```bash
sudo dpkg -i ./ipfs-desktop-[version]-amd64.deb

```

--------------------------------

### Display 'quick-start' Directory Contents

Source: https://docs.ipfs.tech/how-to/command-line-quick-start

Retrieve and display the contents of the 'quick-start' directory from IPFS, which contains example commands.

```bash
ipfs cat /ipfs/bafybeie5nqv6kd3qnfjupgvz34woh3oksc3iau6abmyajn7qvtf6d2ho34/quick-start

```

--------------------------------

### Install Kubo with Homebrew

Source: https://docs.ipfs.tech/install/command-line

Use the Homebrew package manager to install Kubo on macOS.

```bash
brew install ipfs
```

--------------------------------

### Example SHA-256 Checksum for Ubuntu ISO

Source: https://docs.ipfs.tech/concepts/content-addressing

This is an example of a SHA-256 checksum provided on a website for verifying the integrity of a downloaded file.

```text
0xB45165ED3CD437B9FFAD02A2AAD22A4DDC69162470E2622982889CE5826F6E3D ubuntu-20.04.1-desktop-amd64.iso

```

--------------------------------

### Install IPFS Desktop with Scoop

Source: https://docs.ipfs.tech/install/ipfs-desktop

Use these commands to install IPFS Desktop if you are using Scoop on Windows. Ensure you have the 'extras' bucket added.

```bash
scoop bucket add extras && scoop install ipfs-desktop
```

--------------------------------

### Install ipfsspec and fsspec

Source: https://docs.ipfs.tech/quickstart/retrieve

Install the necessary Python libraries for interacting with IPFS via fsspec.

```bash
pip install fsspec ipfsspec

```

--------------------------------

### Verify Linux Installation

Source: https://docs.ipfs.tech/install/command-line

Check the installed Kubo version.

```bash
ipfs --version

> ipfs version 0.42.0
```

--------------------------------

### UnixFS Subsetting Example Directory Structure

Source: https://docs.ipfs.tech/how-to/content-addressing-data-sets

Demonstrates a typical project directory structure that can be subsetted using UnixFS.

```text
project/
├── components/
│   ├── Header.tsx
│   └── Footer.tsx
├── assets/
│   ├── style.css
│   └── logo.png
└── index.html
```

--------------------------------

### Example IPFS Gateway URL

Source: https://docs.ipfs.tech/how-to/address-ipfs-on-web

An example of accessing IPFS content using the `ipfs.io` public gateway.

```text
https://ipfs.io/ipfs/bafybeihkoviema7g3gxyt6la7vd5ho32ictqbilu3wnlo3rs7ewhnp7lly
```

--------------------------------

### Install IPFS Desktop with Chocolatey

Source: https://docs.ipfs.tech/install/ipfs-desktop

Use this command to install IPFS Desktop if you are using Chocolatey on Windows.

```bash
choco install ipfs-desktop
```

--------------------------------

### Install w3cli Tool

Source: https://docs.ipfs.tech/how-to/websites-on-ipfs/deploy-github-action

Install the w3cli tool globally using npm. This command is necessary for interacting with Storacha.

```bash
npm install -g @web3-storage/w3cli

```

--------------------------------

### Install IPFS Desktop with Homebrew

Source: https://docs.ipfs.tech/install/ipfs-desktop

Use this command to install IPFS Desktop if you are using Homebrew on macOS.

```bash
brew install ipfs --cask
```

--------------------------------

### Start Kubo Daemon

Source: https://docs.ipfs.tech/how-to/troubleshooting-kubo

Run this command in your terminal to start the Kubo daemon. Use a separate terminal to interact with the daemon.

```bash
ipfs daemon
```

--------------------------------

### Install IPFS Desktop with AUR

Source: https://docs.ipfs.tech/install/ipfs-desktop

Use this command to install IPFS Desktop if you are using an AUR helper on Arch Linux.

```bash
ipfs-desktop
```

--------------------------------

### Install Kubo Update

Source: https://docs.ipfs.tech/reference/kubo/cli

Downloads, verifies, and installs a specified Kubo version from GitHub Releases. It backs up the current binary and replaces it atomically. Pre-release versions can be included with the --pre flag, and downgrades are allowed with --allow-downgrade.

```bash
ipfs update install [<version>]
```

```bash
ipfs update install [--pre] [--allow-downgrade] [--] [<version>]
```

--------------------------------

### Example CID Path Gateway URLs

Source: https://docs.ipfs.tech/how-to/address-ipfs-on-web

Examples of URLs for accessing specific IPFS content via a path gateway using CIDs.

```text
https://ipfs.io/ipfs/bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq/wiki/Vincent_van_Gogh.html
https://ipfs.io/ipfs/QmT5NvUtoM5nWFfrQdVrFtvGfKFmG7AHE8P34isapyhCxX/wiki/Mars.html

```

--------------------------------

### IPFS and IPNS Native URL Examples

Source: https://docs.ipfs.tech/how-to/address-ipfs-on-web

Examples of native IPFS and IPNS URLs, including paths, queries, and fragments. For IPNS, use a libp2p key or a DNSLink name.

```plaintext
ipfs://{cidv1}
ipfs://{cidv1}/path/to/resource
ipfs://{cidv1}/path/to/resource?query=foo#fragment

ipns://{cidv1-libp2p-key}
ipns://{cidv1-libp2p-key}/path/to/resource
ipns://{dnslink-name}/path/to/resource?query=foo#fragment
```

--------------------------------

### Block Stat Example

Source: https://docs.ipfs.tech/reference/kubo/rpc

This example shows how to get statistics for a specific block using the block/stat endpoint.

```APIDOC
## POST /api/v0/block/stat

### Description
Retrieves statistics for a given IPFS block.

### Method
POST

### Endpoint
/api/v0/block/stat

### Parameters
#### Query Parameters
- **arg** (string) - Required - The CID of the block to get statistics for.
- **encoding** (string) - Optional - The encoding format for the response. Defaults to JSON.

### Request Example
```bash
curl -X POST "http://127.0.0.1:5001/api/v0/block/stat?arg=QmaaqrHyAQm7gALkRW8DcfGX3u8q9rWKnxEMmf7m9z515w&encoding=json"
```

### Response
#### Success Response (200)
- **Key** (string) - The CID of the block.
- **Size** (integer) - The size of the block in bytes.

#### Response Example
```json
{
  "Key": "QmaaqrHyAQm7gALkRW8DcfGX3u8q9rWKnxEMmf7m9z515w",
  "Size": 108
}
```
```

--------------------------------

### cURL Example for IPFS Kubo RPC API: files/stat

Source: https://docs.ipfs.tech/reference/kubo/rpc

Example of how to call the /api/v0/files/stat endpoint using cURL to get file status.

```bash
curl -X POST "http://127.0.0.1:5001/api/v0/files/stat?arg=<path>&format=<hash> Size: <size> CumulativeSize: <cumulsize> ChildBlocks: <childs> Type: <type> Mode: <mode> (<mode-octal>) Mtime: <mtime>&hash=<value>&size=<value>&with-local=<value>"
```

--------------------------------

### Add and List Files for Mounting

Source: https://docs.ipfs.tech/reference/kubo/cli

This example demonstrates adding a file to IPFS and listing its contents, preparing for the mount operation.

```bash
mkdir foo
echo "baz" > foo/bar
ipfs add -r foo
ipfs ls QmSh5e7S6fdcu75LAbXNZAFY2nGyZUJXyLCJDvn2zRkWyC
```

--------------------------------

### Copy IPFS object to MFS

Source: https://docs.ipfs.tech/reference/kubo/cli

Use 'ipfs add' to get the CID of a file, then 'ipfs files cp' to copy it into MFS. This example shows adding a file and then copying its CID to a desired MFS path.

```bash
ipfs add --quieter --pin=false <your file>
# ...
# ... outputs the root CID at the end
ipfs files cp /ipfs/<CID> /your/desired/mfs/path
```

--------------------------------

### Create a file

Source: https://docs.ipfs.tech/how-to/pin-files

Use the echo command to create a sample file with content.

```bash
echo "ipfs rocks" > foo
```

--------------------------------

### Get IPFS Swarm Peers via RPC

Source: https://docs.ipfs.tech/reference/kubo/rpc

This example shows how to retrieve a list of connected peers in the IPFS swarm using the RPC API. It demonstrates the JSON output format that mirrors the CLI command with `--enc=json`.

```bash
curl -X POST http://127.0.0.1:5001/api/v0/swarm/peers
```

```json
{
  "Peers": [
    {
      "Addr": "/ip4/104.131.131.82/tcp/4001",
      "Peer": "QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ",
      ...
    }
  ]
}
```

--------------------------------

### Get Block Statistics using RPC

Source: https://docs.ipfs.tech/reference/kubo/rpc

This example shows how to retrieve statistics for a specific IPFS block using the RPC API. The block's CID is passed as an argument via 'arg', and the output is formatted as JSON using the 'encoding=json' flag.

```bash
curl -X POST "http://127.0.0.1:5001/api/v0/block/stat?arg=QmaaqrHyAQm7gALkRW8DcfGX3u8q9rWKnxEMmf7m9z515w&encoding=json"
```

```json
{
  "Key": "QmaaqrHyAQm7gALkRW8DcfGX3u8q9rWKnxEMmf7m9z515w",
  "Size": 108
}
```

--------------------------------

### Setup for IPFS Mount

Source: https://docs.ipfs.tech/reference/kubo/cli

Before using `ipfs mount`, you may need to create the mount directories and set ownership. Ensure an IPFS daemon is running.

```bash
sudo mkdir /ipfs /ipns /mfs
sudo chown $(whoami) /ipfs /ipns /mfs
ipfs daemon &
```

--------------------------------

### Install Storacha CLI

Source: https://docs.ipfs.tech/quickstart/pin-cli

Install the Storacha command-line interface, which requires Node.js.

```bash
npm install -g @storacha/cli
```

--------------------------------

### Copy File to Directory using MFS

Source: https://docs.ipfs.tech/reference/kubo/cli

This example demonstrates how to copy a file into a directory using the `ipfs files cp` command, which is the recommended approach for managing UnixFS structures.

```bash
ipfs files cp /ipfs/QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn /some-dir
```

--------------------------------

### Example IPFS CID

Source: https://docs.ipfs.tech/how-to/desktop-app

This is an example CID for a file or directory that can be used for downloading.

```plaintext
bafkreig6g5k5tu5k6vgwvwstzn6lzppjtoxzdzczb4fthrcfngetoz4klm
```

--------------------------------

### Initialize Kubo Repository with Server Profile

Source: https://docs.ipfs.tech/how-to/command-line-quick-start

Use the 'server' profile when initializing a Kubo repository on a public-internet host to optimize for server environments and reduce discovery traffic.

```bash
ipfs init --profile server

```

--------------------------------

### Initialize IPFS Node with Kubo CLI

Source: https://docs.ipfs.tech/how-to/kubo-basic-cli

Run this command once to set up the configuration files for your IPFS node. It generates a keypair and a peer identity.

```bash
ipfs init

```

--------------------------------

### Verify Windows Installation

Source: https://docs.ipfs.tech/install/command-line

Check the installed Kubo version using the ipfs.exe executable.

```powershell
.\ipfs.exe --version

> ipfs version 0.42.0
```

--------------------------------

### SHA-1 Hash Example

Source: https://docs.ipfs.tech/concepts/hashing

Demonstrates the SHA-1 hash output for the input 'Hello world'. SHA-1 produces a 160-bit hash.

```text
Hello world


```

```text
0x7B502C3A1F48C8609AE212CDFB639DEE39673F5E

```

--------------------------------

### Build Middleman Site

Source: https://docs.ipfs.tech/how-to/websites-on-ipfs/static-site-generators

Run this command to build your Middleman static site. The output will be placed in the `./build` folder.

```bash
middleman build

```

--------------------------------

### Swarm Disconnect Example

Source: https://docs.ipfs.tech/reference/kubo/rpc

This example demonstrates how to disconnect from a specific peer using the swarm/disconnect endpoint.

```APIDOC
## POST /api/v0/swarm/disconnect

### Description
Disconnects from a specific peer.

### Method
POST

### Endpoint
/api/v0/swarm/disconnect

### Parameters
#### Query Parameters
- **arg** (string) - Required - The multiaddr of the peer to disconnect from.

### Request Example
```bash
curl -X POST "http://127.0.0.1:5001/api/v0/swarm/disconnect?arg=/ip4/54.93.113.247/tcp/48131/p2p/QmUDS3nsBD1X4XK5Jo836fed7SErTyTuQzRqWaiQAyBYMP"
```

### Response
#### Success Response (200)
- **Strings** (array) - Confirmation messages indicating the result of the disconnect operation.

#### Response Example
```json
{
  "Strings": [
    "disconnect QmUDS3nsBD1X4XK5Jo836fed7SErTyTuQzRqWaiQAyBYMP success",
  ]
}
```
```

--------------------------------

### Example Subdomain Gateway URLs

Source: https://docs.ipfs.tech/how-to/address-ipfs-on-web

Examples of how IPFS content can be accessed using subdomain gateways.

```url
https://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq.ipfs.dweb.link/wiki/
```

```url
http://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq.ipfs.localhost:8080/wiki/Vincent_van_Gogh.html
```

--------------------------------

### SHA-256 Hash Example

Source: https://docs.ipfs.tech/concepts/hashing

Shows the SHA-256 hash output for the same input 'Hello world'. SHA-256 produces a longer, 256-bit hash.

```text
0x64EC88CA00B268E5BA1A35678A1B5316D212F4F366B2477232534A8AECA37F3C

```

--------------------------------

### Download docker-compose.yml

Source: https://docs.ipfs.tech/install/server-infrastructure

Download the docker-compose.yml file to set up the IPFS Cluster environment.

```bash
wget https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.1.6/docker-compose.yml

```

--------------------------------

### Add and Get File with Kubo

Source: https://docs.ipfs.tech/how-to/troubleshooting-kubo

Demonstrates adding a file to Kubo on one node and retrieving it on another using its CID. Ensure Kubo is running on both machines before executing.

```bash
# On A
ipfs add myfile.txt
> added bafkreihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku myfile.txt

# On B
ipfs get bafkreihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku
> Saving file(s) to bafkreihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku
> 13 B / 13 B [=====================================================] 100.00% 1s

```

--------------------------------

### Swarm Peers Example

Source: https://docs.ipfs.tech/reference/kubo/rpc

This example shows how to retrieve a list of connected peers using the swarm/peers endpoint.

```APIDOC
## POST /api/v0/swarm/peers

### Description
Retrieves a list of peers connected to the IPFS swarm.

### Method
POST

### Endpoint
/api/v0/swarm/peers

### Request Example
```bash
curl -X POST http://127.0.0.1:5001/api/v0/swarm/peers
```

### Response
#### Success Response (200)
- **Peers** (array) - List of connected peers, each with an Addr and Peer identifier.

#### Response Example
```json
{
  "Peers": [
    {
      "Addr": "/ip4/104.131.131.82/tcp/4001",
      "Peer": "QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ",
      ...
    }
  ]
}
```
```

--------------------------------

### Example IPFS Native URL

Source: https://docs.ipfs.tech/how-to/address-ipfs-on-web

A concrete example of a native IPFS URL pointing to a specific resource.

```plaintext
ipfs://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq/wiki/Vincent_van_Gogh.html
```

--------------------------------

### Listen for IPFS p2p connections

Source: https://docs.ipfs.tech/reference/kubo/rpc

Create a libp2p service to listen for incoming connections. Specify the protocol and target endpoint. Options include allowing custom protocols, reporting peer IDs, and running in the foreground.

```bash
curl -X POST "http://127.0.0.1:5001/api/v0/p2p/listen?arg=<protocol>&arg=<target-address>&allow-custom-protocol=<value>&report-peer-id=<value>&foreground=<value>"
```

--------------------------------

### Build VuePress Site

Source: https://docs.ipfs.tech/how-to/websites-on-ipfs/static-site-generators

Run this command to build your VuePress site. The static files are generated in the `./.vuepress/dist` directory.

```bash
vuepress build

```

--------------------------------

### Create directories

Source: https://docs.ipfs.tech/reference/kubo/rpc

Use this endpoint to create directories. It requires a path and supports options for creating parent directories and specifying CID version or hash function.

```shell
curl -X POST "http://127.0.0.1:5001/api/v0/files/mkdir?arg=<path>&parents=<value>&cid-version=<value>&hash=<value>"
```

--------------------------------

### Verify Docker Installation

Source: https://docs.ipfs.tech/install/server-infrastructure

Check if Docker is installed and view its version information. This is a prerequisite for running IPFS Cluster locally.

```bash
docker version

> Client: Docker Engine - Community
> Version:           19.03.13
> API version:       1.40
> ...


```

--------------------------------

### Create a file for IPNS publishing

Source: https://docs.ipfs.tech/how-to/publish-ipns

Create a simple text file to be added to IPFS and published to IPNS. This example creates a 'hello world' file.

```bash
echo "Hello IPFS" > hello.txt

```

--------------------------------

### Remote Pin Service List Example

Source: https://docs.ipfs.tech/reference/kubo/rpc

This example demonstrates how to list remote pin services with optional status filtering.

```APIDOC
## POST /api/v0/pin/remote/service/ls

### Description
Lists configured remote pin services, with optional filtering by status.

### Method
POST

### Endpoint
/api/v0/pin/remote/service/ls

### Parameters
#### Query Parameters
- **name** (string) - Optional - Filter by the name of the pin service.
- **status** (string) - Optional - Filter by the status of the pin service. Can be specified multiple times.

### Request Example
```bash
curl -X POST "http://127.0.0.1:5001/api/v0/pin/remote/service/ls?name=myservice&status=pinned&status=pinning"
```
```

--------------------------------

### Mount IPFS and Access Content

Source: https://docs.ipfs.tech/reference/kubo/cli

After setting up and starting the daemon, this command mounts IPFS and shows how to access content through the mounted filesystem.

```bash
ipfs mount
cd /ipfs/QmSh5e7S6fdcu75LAbXNZAFY2nGyZUJXyLCJDvn2zRkWyC
ls
cat bar
cat /ipfs/QmSh5e7S6fdcu75LAbXNZAFY2nGyZUJXyLCJDvn2zRkWyC/bar
cat /ipfs/QmWLdkp93sNxGRjnFHPaYg8tCQ35NBY3XPn6KiETd3Z4WR
```

--------------------------------

### Download OpenBSD Binary

Source: https://docs.ipfs.tech/install/command-line

Use wget to download the Kubo OpenBSD binary distribution.

```bash
wget https://dist.ipfs.tech/kubo/v0.42.0/kubo_v0.42.0_openbsd-amd64.tar.gz
```

--------------------------------

### IPFS Cluster Node Startup Log

Source: https://docs.ipfs.tech/install/server-infrastructure

Example log output indicating that IPFS nodes within the cluster are ready and accessible.

```text
> ipfs1       | API server listening on /ip4/0.0.0.0/tcp/5001
> ipfs1       | WebUI: http://0.0.0.0:5001/webui
> ipfs1       | Gateway (readonly) server listening on /ip4/0.0.0.0/tcp/8080
> ipfs1       | Daemon is ready

```

--------------------------------

### Build Next.js Site

Source: https://docs.ipfs.tech/how-to/websites-on-ipfs/static-site-generators

Run this command to build your Next.js site for static export. The output will be in the `./out` directory.

```bash
npx next build

```

--------------------------------

### Start IPFS Daemon with Kubo

Source: https://docs.ipfs.tech/how-to/publish-ipns

Ensure your IPFS daemon is running before publishing IPNS names. This command starts the daemon.

```bash
ipfs daemon

```

--------------------------------

### Initialize IPFS Repository

Source: https://docs.ipfs.tech/reference/kubo/cli

Initializes the IPFS configuration files and generates a new keypair. Use the 'server' profile for server environments. The repository location defaults to ~/.ipfs, but can be changed with the $IPFS_PATH environment variable.

```bash
ipfs init [<default-config>]
```

--------------------------------

### Start IPFS Cluster with docker-compose

Source: https://docs.ipfs.tech/install/server-infrastructure

Start the IPFS Cluster services using docker-compose. This command may require root privileges.

```bash
docker-compose up

```

--------------------------------

### Directory Structure Example

Source: https://docs.ipfs.tech/community/contribute/grammar-formatting-and-style

Illustrates the recommended directory structure for organizing articles and their associated images. Each article with images has a corresponding subfolder within the main 'images' directory.

```tree
ipfs-desktop/
├── download-the-config.md
├── images
│   └── upload-a-photo
│       └── ipfs-desktop-image-upload-screen.png
└── upload-a-photo.md
```

--------------------------------

### Navigate to Project Directory

Source: https://docs.ipfs.tech/how-to/websites-on-ipfs/multipage-website

Change the current directory to your multi-page project's location.

```bash
cd ~/Code/multi-page-first-step
```

--------------------------------

### Example IPNS Path Gateway URL

Source: https://docs.ipfs.tech/how-to/address-ipfs-on-web

An example URL for accessing IPFS content via a path gateway using an IPNS name.

```text
https://ipfs.io/ipns/k51qzi5uqu5dlvj2baxnqndepeb86cbk3ng7n3i46uzyxzyqj2xjonzllnv0v8

```

--------------------------------

### Display Help for IPFS Remote Pinning Commands

Source: https://docs.ipfs.tech/how-to/work-with-pinning-services

Access the help documentation for all `ipfs pin remote` subcommands. This is useful for discovering available options and understanding command usage.

```bash
$ ipfs pin remote --help
```

--------------------------------

### Resolving DNSLink Example

Source: https://docs.ipfs.tech/concepts/dnslink

This example demonstrates how an IPFS client resolves a DNSLink. It shows the dig output for `_dnslink.docs.ipfs.tech` and the resulting IPFS path.

```bash
$ dig +noall +answer TXT _dnslink.docs.ipfs.tech
_dnslink.docs.ipfs.tech.  34  IN  TXT "dnslink=/ipfs/bafybeifld3uybj6azujisdnxu6cm7mombldpbt3au4g33nwnqx7dsgjrta"

/ipns/docs.ipfs.tech/introduction/

/ipfs/bafybeifld3uybj6azujisdnxu6cm7mombldpbt3au4g33nwnqx7dsgjrta/introduction/
```

--------------------------------

### Check Go Version

Source: https://docs.ipfs.tech/how-to/command-line-quick-start

Verify your installed Go version. IPFS requires Go 1.24.0 or later. If an update is needed, install from canonical Go packages.

```bash
go version

> go version go1.24.0 linux/amd64
```

--------------------------------

### Verify Docker Compose Installation

Source: https://docs.ipfs.tech/install/server-infrastructure

Confirm that Docker Compose is installed and display its version. This tool is essential for managing multi-container Docker applications like IPFS Cluster.

```bash
docker-compose version

> docker-compose version 1.27.4, build 40524192
> docker-py version: 4.3.1
> ...


```

--------------------------------

### Create a File

Source: https://docs.ipfs.tech/how-to/command-line-quick-start

Creates a simple text file named 'meow.txt' with the content 'meow'. This file can then be added to IPFS.

```bash
echo "meow" > meow.txt

```

--------------------------------

### Clone a Git repository for hosting

Source: https://docs.ipfs.tech/how-to/host-git-repo

Use this command to create a bare clone of your Git repository, which is suitable for serving.

```bash
git clone --mirror git@myhost.io/myrepo

```
Tokens:
Raw