cl-ipfs-api

A client library for the IPFS API.

Examples

Documentation

CL-IPFS-API (IPFS-API)

[special] *USER-AGENT*

Identifying user-agent string for API calls

[special] *HOST*

Hostname for API calls

[special] *ENCODING*

Default encoding type

[special] *PORT*

Port for all API calls

[special] *API-PATH*

Path prefix for all API calls

[macro] WITH-IPFS-CONNECTION (&REST ARGS)

[function] ADD (PATH &KEY RECURSIVE QUIET PROGRESS TRICKLE ONLY-HASH WRAP-WITH-DIRECTORY HIDDEN CHUNKER TIMEOUT WANT-STREAM)

Add an object to ipfs.

[function] CAT (IPFS-PATH &KEY TIMEOUT WANT-STREAM)

Show IPFS object data.

[function] LS (IPFS-PATH &KEY HEADERS (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

List links from an object.

[function] FILE-LS (IPFS-PATH &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

List directory contents for Unix-filesystem objects.

[function] BLOCK-GET (KEY &KEY TIMEOUT WANT-STREAM)

Get a raw IPFS block

[function] BLOCK-PUT (DATA &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Store input as an IPFS block.

[function] BLOCK-STAT (KEY &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Print information of a raw IPFS block.

[function] OBJECT-GET (KEY &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Get and serialize the DAG node named by KEY.

[function] OBJECT-PUT (DATA &KEY INPUTENC (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

stores input as a DAG object, outputs its key.

[function] OBJECT-STAT (KEY &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Get stats for the DAG node named by KEY.

[function] OBJECT-DATA (KEY &KEY TIMEOUT WANT-STREAM)

Output the raw bytes in an IPFS object.

[function] OBJECT-LINKS (KEY &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Output the links pointed to by the specified object.

[function] OBJECT-NEW (TEMPLATE &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Create a new object from an ipfs template.

[function] OBJECT-PATCH (ROOT COMMAND ARGS &KEY CREATE (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Create a new DAG node based on an existing one.

[function] PIN-ADD (IPFS-PATH &KEY RECURSIVE (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Pin objects to local storage.

[function] PIN-RM (IPFS-PATH &KEY RECURSIVE (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Unpin an object from local storage.

[function] PIN-LS (&KEY TYPE COUNT QUIET (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

List objects pinned to local storage.

[function] REPO-GC (&KEY QUIET (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Perform a garbage collection sweep on non-pinned objects.

[function] SWARM-ADDRS (&KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

List known addresses.

[function] SWARM-PEERS (&KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

List peers with open connections.

[function] SWARM-CONNECT (ADDRESS &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Open connection to a given address.

[function] SWARM-DISCONNECT (ADDRESS &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Close connection to a given address.

[function] SWARM-FILTERS (&KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

List currently applied filters.

[function] SWARM-FILTERS-ADD (ADDRESS &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Add an address filter.

[function] SWARM-FILTERS-RM (ADDRESS &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Remove an address filter.

[function] BOOTSTRAP (&KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Show peers in the bootstrap list.

[function] BOOTSTRAP-ADD (PEERS &KEY DEFAULT (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Add peers to the bootstrap list.

[function] BOOTSTRAP-RM (PEERS &KEY ALL (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Remove peers from the bootstrap list.

[function] REFS (IPFS-PATH &KEY FORMAT EDGES UNIQUE RECURSIVE (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

List links (references) from an object.

[function] REFS-LOCAL (&KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

List all local references.

[function] RESOLVE (NAME &KEY RECURSIVE (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Resolve the value of names to IPFS.

[function] NAME-PUBLISH (NAME IPFS-PATH &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Publish an object to IPNS.

[function] NAME-RESOLVE (NAME &KEY RECURSIVE WANT-STREAM)

Get the value currently published at an IPNS name.

[function] DNS (DOMAIN-NAME &KEY RECURSIVE (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

DNS link resolver.

[function] DHT-QUERY (PEER-ID &KEY VERBOSE (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Run a 'FindClosestPeers' query through the DHT.

[function] DHT-GET (KEY &KEY VERBOSE (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Run a 'GetValue' query through the DHT.

[function] DHT-PUT (KEY VALUE &KEY VERBOSE (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Run a 'PutValue' query through the DHT.

[function] DHT-FINDPEER (PEER-ID &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Run a 'FindPeer' query through the DHT.

[function] DHT-FINDPROVS (KEY &KEY VERBOSE (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Run a 'FindProviders' query through the DHT.

[function] PING (PEER-ID &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Send echo request packets to IPFS hosts.

[function] CONFIG (KEY VALUE &KEY BOOL JSON (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Get and set IPFS config values.

[function] CONFIG-SHOW (&KEY TIMEOUT WANT-STREAM)

Outputs the content of the config file.

[function] CONFIG-REPLACE (FILE &KEY (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Replace the config with FILE.

[function] ID (&KEY FORMAT (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Show IPFS Node ID information

[function] VERSION (&KEY NUMBER (ENCODING *ENCODING*) TIMEOUT WANT-STREAM)

Show IPFS version information.

Testing

(asdf:test-system :cl-ipfs-api)

License

MIT