Package Exports

ipld-explorer-cli

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ipld-explorer-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ipld-explorer-cli

Explore the IPLD directed acyclic graph with your keyboard

Install

Ensure you have at least:

node@8
go-ipfs@0.4 or js-ipfs@0.31

Install the explorer:

npm install --global ipld-explorer-cli

Start your Go/JS IPFS daemon:

ipfs daemon
# or
jsipfs daemon

Usage

$ ipld-explorer

Welcome to the IPLD explorer REPL!
Type "help" then <Enter> for a list of commands

? >

If you use JS-IPFS, make sure you set the apiAddr accordingly:

? > config set apiAddr /ip4/127.0.0.1/tcp/5002

Commands

`cd [path]` (alias `get`)

Change DAG. Changes the current working DAG node to the specified path. If the path is starts with /ipfs or is a CID then change to that path otherwise path is taken to be relative to the current working DAG path.

`pwd`

Print working DAG. Prints the path of the current working DAG.

`resolve [path]`

Walk down the provided path and print the object found there. path defaults to CWD (current working DAG) if not specified.

`ls [path]`

List the entries at a path. path defaults to CWD (current working DAG) if not specified.

`config set <key> <value>`

Set a config value.

Configuration

The following configuration keys are valid:

apiAddr - The multiaddr of the IPFS node to use (default: /ip4/127.0.0.1/tcp/5001)

`config get [key]`

Get a config value or get all config if no key is provided.

`help`

Print the help information.

`version`

Prints the version of the ipld-explorer.

`exit`

Quit the explorer.

Contribute

Feel free to dive in! Open an issue or submit PRs.