Common Usage

TRON Foundation
Oct 11 · 2 min read

Add a File

Run the btfs add command:

Get a File

Run the btfs get command:

File Pinning

In the default configuration, BTFS nodes garbage collect their cache when the storage exceeds the max capacity threshold set in the configuration file. Pinned files, however, are exempt from the garbage collection process.

You can also publish the uploaded file for your local BTFS node to host:

Check your local BTFS node’s peer ID to see which file is hosted:

View your hosted file through the gateway at<PeerID>.

Domain Binding

Domain binding allows you to display the hosted file path as a standard URL domain rather than the peer ID of your BTFS node. For example, assuming you own “", domain binding allows you to create a URL path like

To bind the domain, the domain DNS settings must be changed by adding a DNS TXT record of the form “dnslink=/btfs/<peerID>”.


TRON Foundation

Written by

The official Medium of Tron Foundation. Learn more:




Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch
Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore
Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade