BTFS

The BTFS Developer Hub

Welcome to the BTFS developer hub. You'll find comprehensive guides and documentation to help you start working with BTFS as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Basic

Command
Description

init

Initialize a BTFS local configuration

add <path>

Add a file to BTFS

cat <ref>

Show BTFS object data

get <ref>

Download BTFS objects

ls <ref>

List links from an object

refs <ref>

List hashes of links from an object

Data Structure

Command
Description

block

Interact with raw blocks in the datastore

object

Interact with raw dag nodes

files

Interact with objects as if they were a UNIX filesystem

dag

Interact with dag objects

Advanced

Command
Description

daemon

Start a long-running daemon process

mount

Mount a BTFS read-only mountpoint

resolve

Resolve any type of name

name

Publish and resolve BTNS names

key

Create and list BTNS name keypairs

Resolve DNS links

pin

Pin objects to local storage

repo

Manipulate the BTFS repository

stats

Various operational stats

p2p

Libp2p stream mounting

filestore

Manage the filestore (experimental)

Network

Command
Description

id

Show info about BTFS peers

bootstrap

Add or remove bootstrap peers

swarm

Manage connections to the p2p network

dht

Query the DHT for values or peers

ping

Measure the latency of a connection

diag

Print diagnostics

Tool

Command
Description

config

Manage configuration

version

Show BTFS version information

update

Download and apply go-btfs updates

commands

List all available commands

cid

Convert and discover the properties of CIDs

log

Manage and show logs of running daemon

CLI


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.