https://github.com/tableflip/ipld-explorer-cli
🔎 Explore the IPLD directed acyclic graph with your keyboard
https://github.com/tableflip/ipld-explorer-cli
acyclic cli dag directed explore forest graph hash ipld link merkle node repl tree
Last synced: 22 days ago
JSON representation
🔎 Explore the IPLD directed acyclic graph with your keyboard
- Host: GitHub
- URL: https://github.com/tableflip/ipld-explorer-cli
- Owner: tableflip
- License: mit
- Created: 2018-04-18T14:52:53.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-09T14:26:21.000Z (over 6 years ago)
- Last Synced: 2025-03-21T18:01:45.849Z (about 1 month ago)
- Topics: acyclic, cli, dag, directed, explore, forest, graph, hash, ipld, link, merkle, node, repl, tree
- Language: JavaScript
- Homepage:
- Size: 459 KB
- Stars: 22
- Watchers: 2
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ipld-explorer-cli
[](https://travis-ci.org/tableflip/ipld-explorer-cli) [](https://david-dm.org/tableflip/ipld-explorer-cli) [](https://standardjs.com)
> Explore the IPLD directed acyclic graph with your keyboard
## Install
Ensure you have at least:
* node@8
* [email protected] or [email protected]
Install the explorer:
```sh
npm install --global ipld-explorer-cli
```
Start your Go/JS IPFS daemon:
```sh
ipfs daemon
# or
jsipfs daemon
```
## Usage
```sh
$ ipld-explorer
Welcome to the IPLD explorer REPL!
Type "help" then for a list of commands
? >
```
If you use JS-IPFS, make sure you set the `apiAddr` accordingly:
```sh
? > 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 `
Set a config value.
##### Configuration
The following configuration keys are valid:
* `apiAddr` - The [multiaddr](https://multiformats.io/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](https://github.com/tableflip/ipld-explorer-cli/issues/new) or submit PRs.
## License
[MIT](LICENSE) © Alan Shaw