Skip to content
This repository has been archived by the owner on Apr 16, 2021. It is now read-only.

Explains the Files API a little bit more #43

Merged
merged 1 commit into from
Apr 9, 2016
Merged

Explains the Files API a little bit more #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions src/14-ipfs-0-4-0-released/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,46 @@ subcommand: `ipfs files`. This subcommand allows a program to interact with IPFS
using familiar filesystem operations, namely: creating directories, reading, writing
and deleting files, listing out different directories, and so on.

This feature enables any application that uses a filesystem-like backend
to use IPFS for storage without changing the application logic at all.

It is used like so:

```sh
> ipfs files mkdir /cats

> ipfs files ls /
cats
> echo foo | ipfs files write --create /cats/foo

> echo bar | ipfs files write --create /cats/foo

> ipfs files ls /cats
foo

> ipfs files read /cats/foo
bar

> ipfs files stat /
QmNU8HmaeRa8VtfqAoQRJhSE5Zx54vyYf2nT1bDGcYXaNv
...

# /ipfs/QmNU8HmaeRa8VtfqAoQRJhSE5Zx54vyYf2nT1bDGcYXaNv is a snapshot
# of this file system!

# You can see it locally or on the public gateway:
# https://ipfs.io/ipfs/QmNU8HmaeRa8VtfqAoQRJhSE5Zx54vyYf2nT1bDGcYXaNv

# Subsequent edits will produce a new /ipfs address for the root directory.
```

This feature enables any other application that uses a filesystem-like backend,
to use IPFS for storage without changing the application logic at all.
One great example of this is [ipfs-blob-store](https://github.com/ipfs/ipfs-blob-store),
an IPFS-backed storage driver that implements the
[blob-store-interface](https://github.com/maxogden/abstract-blob-store), so that any app
that uses one of the other blob-store storage drivers (S3, indexeddb,
levelDB, etc), can now use IPFS with a simple swap.
[registry-mirror](https://github.com/diasdavid/registry-mirror) uses this
that uses any other blob-store storage driver (S3, IndexedDB, LevelDB, etc) can now use
IPFS. [registry-mirror](https://github.com/diasdavid/registry-mirror) uses this
approach to mirror the npm registry onto IPFS.

We are looking forward to see more use cases with this new convinient and powerful API.
We are looking forward to seeing more use cases of this new convenient and powerful API.

## Why we're changing the protocol

Expand Down