Skip to content

Commit

Permalink
feat: implement cli
Browse files Browse the repository at this point in the history
  • Loading branch information
SgtPooki committed Apr 2, 2024
1 parent a980420 commit 0d2be9f
Show file tree
Hide file tree
Showing 7 changed files with 31,304 additions and 2 deletions.
10 changes: 10 additions & 0 deletions .aegir.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/** @type {import('aegir').PartialOptions} */
const options = {
build: {
config: {
platform: 'node'
}
}
}

export default options
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dist
tmp
node_modules
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,34 @@
# helia-verified-fetch-cli
A simple CLI for downloading IPFS content using @helia/verified-fetch
# @sgtpooki/helia-verified-fetch-cli

`@sgtpooki/helia-verified-fetch-cli` is a command-line interface tool designed to facilitate the download and fetching of content using the Helia protocol and `@helia/verified-fetch`. It leverages various block brokers such as bitswap and trustless gateways to ensure secure and efficient data retrieval.

## Installation

To install `@sgtpooki/helia-verified-fetch-cli`, you need to have Node.js installed on your system. With Node.js installed, run the following command:

```sh
npm install -g @sgtpooki/helia-verified-fetch-cli
```

## Usage
After installation, you can use the CLI tool by invoking it with the desired resource URL and additional options as needed.

## Basic Usage
To fetch a resource, simply provide the resource URL as follows:

`helia-verified-fetch-cli <resource-url>`


## Options

- `--data, -d`: Specify the directory to persist data/blockstore. By default, data is stored in-memory and will not persist between requests.
- `--use-bitswap, -b`: Use bitswap block broker. Enabled by default.
- `--use-trustless-gateways, -t`: Use trustless gateways. Enabled by default.
- `--trustless-gateways`: Provide a list of trustless gateways to use. Defaults to Helia default trustless gateways.
- `--accept, -a`: Set the Accept header for the request.
- `--verbose, -v`: Enable verbose logging, similar to setting DEBUG="helia*" in your environment variables.
- `--debug`: Set the DEBUG environment variable to the provided value.

## Callouts

- Currently, piping json to `jq` will fail with `jq: parse error: Unfinished JSON term at EOF at line 2129, column 7`. If you write to a file and then pipe to `jq`, it will work as expected.
Loading

0 comments on commit 0d2be9f

Please sign in to comment.