Skip to content

hyparam/hyperparam-cli

Repository files navigation

hyperparam

npm workflow status mit license coverage

This is the hyperparam cli tool.

The hyperparam cli tool is for viewing arbitrarily large datasets in the browser.

Viewer

To open a file browser in your current local directory run:

npx hyperparam

You can also pass a specific file, folder, or url:

npx hyperparam example.parquet
npx hyperparam directory/
npx hyperparam https://hyperparam-public.s3.amazonaws.com/bunnies.parquet

Chat

To start a chat with hyperparam:

npx hyperparam chat

Installation

Install for all users:

sudo npm i -g hyperparam

Now you can just run:

hyperparam

or:

hyp

Developers

To develop the CLI locally:

npm i
npm run build
npm run serve

When you make changes, make sure to rebuild:

npm run build

Then refresh the browser.