Hyperparam is a tool for exploring and analyzing large datasets in the browser.

The Hyperparam CLI is currently only for development and testing purposes. You should probably just use hyperparam.app.

Use the Hyperparam CLI to open a file browser in your current local directory:

npx hyperparam

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

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

To start a CLI chat with Hyperparam:

npx hyperparam chat

Install Hyperparam CLI globally:

sudo npm i -g hyperparam

Now you can just run:

hyperparam

or simply:

hyp

To develop the CLI locally:

npm i
npm run dev

The application will rebuild automatically when you make changes, and the browser will refresh.

Hyperparam is an application that relies on node.js scripts in the bin/ directory and serves the static web application built in the dist/ directory.

The hyperparam package also includes a library of components that can be used in other applications. The library is in the lib/ directory. For example:

import { asyncBufferFrom, AsyncBufferFrom, parquetDataFrame } from 'hyperparam'

If you encounter any issues with the web worker, you might have to configure your bundler. For example, in Vite, you can use the following configuration:

import { defineConfig } from 'vite'
export default defineConfig({
  ...
  optimizeDeps: {
    exclude: ['hyperparam'],
  },
})