# README
go-unixfs
go-unixfs implements unix-like filesystem utilities on top of an ipld merkledag
ā This repo is no longer maintained.
š We highly recommend switching to the maintained version at https://github.com/ipfs/boxo/tree/main/ipld/unixfs.
šļø Good news! There is tooling and documentation to expedite a switch in your repo.
ā ļø If you continue using this repo, please note that security fixes will not be provided (unless someone steps in to maintain it).
š Learn more, including how to take the maintainership mantle or ask questions, here.
Table of Contents
Package Directory
This package contains many subpackages, each of which can be very large on its own.
Top Level
The top level unixfs package defines the unixfs format datastructures, and some helper methods around it.
importers
The importer subpackage is what you'll use when you want to turn a normal file into a unixfs file.
io
The io subpackage provides helpers for reading files and manipulating directories. The DagReader takes a
reference to a unixfs file and returns a file handle that can be read from and seeked through. The Directory
interface allows you to easily read items in a directory, add items to a directory, and do lookups.
mod
The mod subpackage implements a DagModifier type that can be used to write to an existing unixfs file, or
create a new one. The logic for this is significantly more complicated than for the dagreader, so its a separate
type. (TODO: maybe it still belongs in the io subpackage though?)
hamt
The hamt subpackage implements a CHAMP hamt that is used in unixfs directory sharding.
archive
The archive subpackage implements a tar importer and exporter. The objects created here are not officially unixfs,
but in the future, this may be integrated more directly.
test
The test subpackage provides several utilities to make testing unixfs related things easier.
Install
go get github.com/ipfs/go-unixfs
License
MIT Ā© Juan Batiz-Benet